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

Disclaimer for Github pages / jekyll quirk #1355

Merged
merged 6 commits into from
Sep 13, 2021
Merged

Disclaimer for Github pages / jekyll quirk #1355

merged 6 commits into from
Sep 13, 2021

Conversation

Tc-001
Copy link
Contributor

@Tc-001 Tc-001 commented Sep 13, 2021

Changes

  • Adds a disclaimer+workaround to Github pages deploy guide
    • By default, github pages will deny access to the _astro/ directory. Add an empty .nojekyll file in the public folder for your site to function properly.

    • Am open to feedback about rewording/reformattimg the disclaimer

References:
https://discord.com/channels/830184174198718474/887002135403827240/ (help thread where this came up)
mpetrovich/stylemark#65 (another issue with the fix)

Testing

No testing, only docs changed.

Docs

Documentation updated

@Tc-001 Tc-001 requested a review from a team as a code owner September 13, 2021 16:35
@changeset-bot
Copy link

changeset-bot bot commented Sep 13, 2021

🦋 Changeset detected

Latest commit: 0d2c9e5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
docs Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@vercel
Copy link

vercel bot commented Sep 13, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

astro-docs – ./docs

🔍 Inspect: https://vercel.com/pikapkg/astro-docs/GheSg7aQxs5zNrfdWgJZXenwbCpE
✅ Preview: https://astro-docs-git-fork-tc-001-main-pikapkg.vercel.app

astro-www – ./www

🔍 Inspect: https://vercel.com/pikapkg/astro-www/5gpHUzp68MWbt9foDayi5E7GYDqD
✅ Preview: https://astro-www-git-fork-tc-001-main-pikapkg.vercel.app

@Tc-001 Tc-001 changed the title Github pages deny access to the _astro folder by default, added warning+fix Disclaimer for Github pages / jekyll quirk Sep 13, 2021
@Tc-001
Copy link
Contributor Author

Tc-001 commented Sep 13, 2021

Reworded the disclaimer, I think the narrow docs size is throwing off my "text quality" detector for some reason 😅

Copy link
Member

@MarcusOtter MarcusOtter left a comment

Choose a reason for hiding this comment

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

LGTM, just nit change to write GitHub Pages with correct letter casing

@FredKSchott
Copy link
Member

Did a small rewrite but overall LGTM!

@FredKSchott FredKSchott merged commit 6b8630c into withastro:main Sep 13, 2021
@MarcusOtter MarcusOtter mentioned this pull request Sep 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants