Skip to content

Add tip for GitHub Private Pages#5635

Merged
sarah11918 merged 5 commits into
withastro:mainfrom
alvgaona:github-private-pages
Dec 20, 2023
Merged

Add tip for GitHub Private Pages#5635
sarah11918 merged 5 commits into
withastro:mainfrom
alvgaona:github-private-pages

Conversation

@alvgaona
Copy link
Copy Markdown
Contributor

@alvgaona alvgaona commented Dec 6, 2023 •
edited
Loading

Description

The current documentation does not completely take into account private GitHub Pages within organizations. GitHub will create a random URL that needs a different treatment.

@vercel
Copy link
Copy Markdown

vercel Bot commented Dec 6, 2023 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Dec 20, 2023 7:08pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Visit Preview Dec 20, 2023 7:08pm

dreyfus92
dreyfus92 requested changes Dec 6, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

Hey @alvgaona, thanks for tackling this 😁. I left a small suggestion.

Comment thread src/content/docs/en/guides/deploy/github.mdx Outdated
@alvgaona alvgaona requested a review from dreyfus92 December 6, 2023 14:38
dreyfus92
dreyfus92 approved these changes Dec 6, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

LGTM ✅

alvgaona and others added 3 commits December 6, 2023 16:49
@alvgaona
Add GitHub Pages tip
e05df49
@alvgaona
Fix text
1e21006
@alvgaona @dreyfus92
Update src/content/docs/en/guides/deploy/github.mdx
880f1a9 
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label Dec 11, 2023
lilnasy
lilnasy reviewed Dec 13, 2023
View reviewed changes
Comment thread src/content/docs/en/guides/deploy/github.mdx Outdated
https://<random-string>.pages.github.io/
```

Make sure to set the `site` key to match the auto-generated URL. There's no need to specify a `base` key.
Copy link
Copy Markdown
Contributor

@lilnasy lilnasy Dec 13, 2023

Choose a reason for hiding this comment

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

What happens when the site config is not set or set to an incorrect origin?

@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Dec 13, 2023

Hi @alvgaona ! This is just a quick note to let you know I'll be looking at this submission this week!

I know it might seem like a small addition, and maybe shouldn't need much review, but even though you've only added a "tip"... when you look at your submission in the surrounding context of the page, it looks like this:

notecautiontip

This... does not make for good docs. 😅

What this tells me is that we need to rework our actual documentation with better guidance on using base... just adding on more notes, cautions and tips is not the solution here. This is why I haven't yet had the time to review your PR (it's not a "quick win" for me during a busy launch week) and clearly is an indication of much bigger docs work that needs to happen.

But, it is on my plate to address this! Thank you for your patience!

@sarah11918 sarah11918 added the can of worms These are bigger than they appear - indicate more docs work needed label Dec 13, 2023
@ElianCodes ElianCodes self-requested a review December 14, 2023 14:28
@sarah11918
Copy link
Copy Markdown
Member

sarah11918 commented Dec 20, 2023

OK! Thank you for your patience @alvgaona ! 🙌

There were just too many notes and cautions etc. so that told me that this content needed to be restructured. In fact, I made sections for using a custom domain vs not, since that often determines what you do or don't have to set.

I did of course include the information you provided, just in a different place/way. Thank you for contributing to this page!

@alvgaona
Copy link
Copy Markdown
Contributor Author

alvgaona commented Dec 20, 2023

OK! Thank you for your patience @alvgaona ! 🙌

There were just too many notes and cautions etc. so that told me that this content needed to be restructured. In fact, I made sections for using a custom domain vs not, since that often determines what you do or don't have to set.

I did of course include the information you provided, just in a different place/way. Thank you for contributing to this page!

Thank you, @sarah11918! I

@sarah11918 sarah11918 merged commit 29bc970 into withastro:main Dec 20, 2023
@100gle 100gle mentioned this pull request Dec 24, 2023
Merged
@McFlyPartages McFlyPartages mentioned this pull request Jan 3, 2024
Merged
yanthomasdev added a commit that referenced this pull request Jan 4, 2024
@McFlyPartages @thomasbnt @yanthomasdev
i18n(fr) Update github.mdx (#6086)
c188e67 
* i18n(fr) Update `github.mdx`

Just for refresh translator tracker.

* Update github.mdx

Update with PR #5635

* Update github.mdx

* Update src/content/docs/fr/guides/deploy/github.mdx

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>

* Update src/content/docs/fr/guides/deploy/github.mdx

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>

---------

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
ematipico pushed a commit that referenced this pull request Jan 26, 2024
@alvgaona @dreyfus92
@sarah11918 @ematipico
Add tip for GitHub Private Pages (#5635)
bc59f37 
Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
ematipico pushed a commit that referenced this pull request Jan 26, 2024
@McFlyPartages @thomasbnt
@yanthomasdev @ematipico
i18n(fr) Update github.mdx (#6086)
65d3f05 
* i18n(fr) Update `github.mdx`

Just for refresh translator tracker.

* Update github.mdx

Update with PR #5635

* Update github.mdx

* Update src/content/docs/fr/guides/deploy/github.mdx

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>

* Update src/content/docs/fr/guides/deploy/github.mdx

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>

---------

Co-authored-by: Thomas Bonnet <thomasbnt@protonmail.com>
Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dreyfus92 dreyfus92 dreyfus92 approved these changes

@ElianCodes ElianCodes Awaiting requested review from ElianCodes

+1 more reviewer

@lilnasy lilnasy lilnasy left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

can of worms These are bigger than they appear - indicate more docs work needed improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@alvgaona @sarah11918 @lilnasy @dreyfus92