docs
docs copied to clipboard
Clarify GitHub Pages `base` config and `withastro/action` usage
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
- Closes #10868
- Suggested label:
improve or update documentation
Deploy Preview for astro-docs-2 failed. Why did it fail? →
Built without sensitive environment variables
| Name | Link |
|---|---|
| Latest commit | cef4f82d20af2c7616babc41d8c31aef51192f99 |
| Latest deploy log | https://app.netlify.com/projects/astro-docs-2/deploys/688cc926a7469b000898936c |
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. |
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/CNAMEfile to your project:"
to maybe "better" instructions like:
You can set up a custom domain by adding a
CNAMEfile to your project'spublic/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!)
(Just fixed the merge conflict)
Hi casungo! I'm going to close this PR for now because there hasn't been any activity here in a while. And, like I mentioned before, I don't believe it addresses the one thing that solves the original issue, and this has just a little too much going on here that is focused on improvements vs the task of updating inaccurate information!
There is a discord thread where people are discussing how to handle the .nojekyll file, and I think that's going to end up being the fix this page needs first. Then, if there are improvements to be made, you're welcome to revisit the page! :raised_hands: