Skip to content
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

Clarify the use of the base parameter for deployment to GitHub Pages #5131

Merged

Conversation

jdwilkin4
Copy link
Contributor

@jdwilkin4 jdwilkin4 commented Oct 18, 2023

Description (required)

This PR is responsible for clarifying the instructions for when to use the base parameter when deploying astro applications to GitHub pages.

I referenced to the solution suggested in this comment of the issue

Updated changes

Screenshot 2023-10-17 at 11 51 41 PM

I am taking part in hacktoberfest 👍

Related issues & labels (optional)

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

@netlify
Copy link

netlify bot commented Oct 18, 2023

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 52b6ccc
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/65315dde85542f0008e6bfbd
😎 Deploy Preview https://deploy-preview-5131--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 site configuration.

@sarah11918 sarah11918 added improve documentation Enhance existing documentation (e.g. add an example, improve description) hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest labels Oct 19, 2023
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

This looks great, thank you so much for jumping on this issue! 🙌

I just shortened it by making it all one list, since reading the issue I don't think there's anything special about the one case? I think they can all go in the list?

And, since we're no longer talking about just the name of the repo, but its full URL, I think saying it's "located at" now makes more contextual sense in that point.

GitHub suggests are stupid when there's a deleted line, so it was unfortunately easier for me just to edit the page (which requires me to commit back directly) rather than make a suggestion for you to commit. Sorry, I normally prefer to just make a suggestion and let the author commit themselves!

So, I've just made the change, added the Hacktoberfest label, and when the tests pass and the preview checks out, I'll just merge straight away! 🙌

@sarah11918 sarah11918 merged commit 2ba7eb9 into withastro:main Oct 19, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hacktoberfest-accepted Mark a PR as accepted to contribute towards Hacktoberfest improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify Your repository is named <YOUR_USERNAME>.github.io.
2 participants