Skip to content

Clarify GitHub Pages base config and withastro/action usage #11753

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

casungo
Copy link
Contributor

@casungo casungo commented May 24, 2025

Description

This PR updates the English documentation for deploying Astro sites to GitHub Pages (guides/deploy/github.mdx) to address several points of confusion and provide clearer, more accurate instructions.

These changes aim to significantly reduce confusion for users deploying to GitHub Pages subpaths and improve the reliability of their setups by promoting best practices for path handling.

Related issues & labels

Copy link

netlify bot commented May 24, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit ce3aca9
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/68311baf86c7280008b8d6af
😎 Deploy Preview https://deploy-preview-11753--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
Copy link
Contributor

astrobot-houston commented May 24, 2025

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
Member

Hi @casungo ! Sorry this PR hasn't had much activity on it! I was hoping someone would be available to help go through this!

Firstly, there are conflicts to resolve. Would you mind handling those?

Secondly, the linked issue mentions that this did not fix someone's problem, but linked to a blog post showing adding a nojekyll file did, and I know that has been a solution to people in the past. I don't see this updated for that extra information in the issue, so I think it would be important to add that here.

Since I haven't had a chance to carefully go through this, I do want to first only update what is incorrect so that these instructions lead to success for someone. (Vs changing explanations / descriptions because they might be "better"). It is much easier to review a PR that only includes corrections for things that are wrong than one that also tries to improve it in various ways. And, since we're struggling to keep up with PRs right now, we need all the help we can get! 😅

So, can we make sure this PR is only about correcting wrong or missing info, so that we can this reviewed and merged more quickly? For example, this PR changes statements that are correct like:

You can set up a custom domain by adding the following ./public/CNAME file to your project:"

to maybe "better" instructions like:

You can set up a custom domain by adding a CNAME file to your project's public/ directory:"

but these don't fix a problem with incorrect statements at this time. I don't disagree that your statement is better! But, there are many of these "upgrades" that don't fix a problem, and that makes it harder to spot the things that actually are incorrect, and make this PR take longer to review. 😅 Right now, we really need to optimize for correcting inaccuracies!

Would you be willing to rework this PR in the above ways? (Resolve conflicts, figure out how to helpfully add the nojekyll information, and only focus on correcting things that are wrong/missing statements?) That would be super helpful, and we could get moving on this! (And, a later PR with "improvements" would always be welcome, where we can concentrate only on language, knowing that the basic steps all work!)

@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

(en) github.mdx: The description of the text is discrepancy.
3 participants