Skip to content

Update GitHub Pages deploy guide with more focus on steps - #12176

Merged
sarah11918 merged 13 commits into
mainfrom
sarah11918-github-pages
Aug 22, 2025
Merged

sarah11918 merged 13 commits into
mainfrom
sarah11918-github-pages

Conversation

@sarah11918

@sarah11918 sarah11918 commented Aug 20, 2025 •

Copy link
Copy Markdown
Member

Deploy preview: https://deploy-preview-12176--astro-docs-2.netlify.app/en/guides/deploy/github/

Based on feedback that this guide was difficult to follow, in part because it seemed like the GitHub Action was optional when it's really a required part of using this guide to deploy, this PR restructures the existing content to:

  • emphasize that this guide is about deploying to GitHub Pages with the GitHub Action
  • combines multiple sections into one set of steps to successfully configure the Action and astro.config.mjs to be able to deploy to a GitHub URL
  • leaves one section for using a custom domain, but reframes it as steps you can perform after you have followed the above instructions and successfully deployed (again, reinforcing that both the action and the Astro config must be updated in order to deploy)
  • removes mention of Bun that somehow snuck in there. This does not belong here as it is not officially supported. People can extrapolate from the given instructions.

Other than reorganizing and turning headings/paragraphs into step items, the content here is unchanged.

@sarah11918 sarah11918 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) 3rd-party guide Community submitted CMS, deploy, backend etc. guide labels Aug 20, 2025
@netlify

netlify Bot commented Aug 20, 2025 •

Copy link
Copy Markdown

✅ Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 1e9abc4
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/68a8ada9e827d60008f85693
😎 Deploy Preview https://deploy-preview-12176--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@astrobot-houston

astrobot-houston commented Aug 20, 2025 •

Copy link
Copy Markdown
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/deploy/github.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@sarah11918

Copy link
Copy Markdown
Member Author

Per Fryuni remember to add that you cannot have an adapter installed

delucis and others added 2 commits August 21, 2025 15:31
Co-authored-by: Junseong Park <39112954+jsparkdev@users.noreply.github.com>
@anaxite

anaxite commented Aug 21, 2025

Copy link
Copy Markdown
Contributor

Came here from Talking and Doc'ing.

@hkbertoson hkbertoson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope i did this review thing right. I dont do it often on Github.

@ArmandPhilippot ArmandPhilippot left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately I wasn't available for T&D, so I don't have the discussion history. I must say I find it a bit confusing to read A value for `base` is required then You do not need a value for`base `. But I know this page is a bit cursed, so this is probably fine. 😅

I only spotted an error I think for the base value. Otherwise, LGTM!

Co-authored-by: Armand Philippot <git@armand.philippot.eu>

@bjohansebas bjohansebas left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!, The content looks good to me now

@hkbertoson hkbertoson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jsparkdev

Copy link
Copy Markdown
Member

LGTM

@yanthomasdev yanthomasdev left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!

@delucis delucis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hero we need, facing down the hydra of deployment guides, where you commit once, and two issues arise. I have no doubt though that Sarah will emerge triumphant! 🐲

@delucis delucis left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Time to deploy!

@sarah11918
sarah11918 merged commit 64f76f7 into main Aug 22, 2025
@sarah11918
sarah11918 deleted the sarah11918-github-pages branch August 22, 2025 18:10
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Aug 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3rd-party guide Community submitted CMS, deploy, backend etc. guide improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants