Repository navigation
docs: mention .nojekyll file to avoid issues with _astro directory - #12106
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
sarah11918
left a comment
There was a problem hiding this comment.
This looks great, and just like what I was thinking of @trueberryless !
I've done some light editing of the text for your consideration!
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
|
Awesome, thanks for all the beautiful suggestions, reads much more user-friendly now! 🙌 LGTM 👍 |
sarah11918
left a comment
There was a problem hiding this comment.
Thank you for adding this extra needed info so people can be successful deploying! I don't doubt that there are other improvements that could be made to this page, but our immediate need was to make sure people had the new info that was missing, and this does that wonderfully! 🎉
|
I investigated this before. My finding is if I follow the guide and use |
|
I just read the discussion on Discord. This PR really simplifies the whole thing too much. I disagree with this PR but I don't think it'll be changed. I had better not translate it and add a caution in my blog post. |
|
Thanks @vrabe — I don’t have the full context, but was also a bit surprised to see this PR as I’ve often deployed to GH Pages using the approach in this guide and never needed a |
@vrabe I don't know why you don't think it will be changed! We had two people testing and following advice found in others blogs and this worked for them, and it seemed consistent with content linked from the issue of someone saying "this worked for me" so we published it. We really do want to get it correct, of course! Can you suggest exactly what is incorrect here? As in, by editing sections of text with suggested improved wording? It seems that no one can ever agree on this guide in particular, and I honestly don't know why it causes so many problems for people and yet there never seems to be one method that everyone agrees on. The only thing I can do is review changes to text as I'm unfamiliar with this deploy method myself, and need people saying "this part of the instruction should say X instead" to give examples of updated text that corrects it. I don't know how to interpret and improve this document based on "this simplifies it too much" and can only rely on our reviewers who report that following the instructions does or doesn't work for them. If you are willing to contribute corrections, then please do! That is the only way these guides are improved and we welcome that! |
|
@sarah11918 It's completely correct! It's just in the wrong place. I don't want readers follow the guide and add the file which isn't needed even though it's not harmful. Instead users who write their own workflow files and/or upload their builds to |
|
Thanks @vrabe for catching that! I was part of the earlier discussion and since I'm not familiar with Github Pages, I wasn't aware of these subtleties! Doing some researches in Github docs, I thought the Rereading Static site generators (for future reference, in case this topic came up again) with your explanation makes a bit more sense. But, I think the need or not of a So thank you again for testing and reporting this! 🙌🏽 |
|
Thanks @vrabe and for all the extra context! You may have noticed that we've reverted this PR to go back to the original guide, and you're right, we don't mention deploying with While it is possible to deploy in different ways, the docs team has decided that the only method we intend to document is using our GitHub Action. So in future, we shouldn't end up making this mistake again! 😄 And, if someone reports deployment not working for them, we will confirm that they are following this method, exactly as laid out. If they decide they would rather deploy another way, they are welcome to, and they can visit support for help, but we will not be documenting any other methods. Thank you again for helping us sort through this all! Many of us here are not experience with GH Pages deployment, and are trying our best to respond when people report issues following our instructions. But now, I think more of us are better informed about how to respond to reports like this in future because of your input! |
Description (required)
Add documentation for adding a
.nojekyllfile and downgrade the other caution aside to normal text.Also adding a link in the new paragraph to this article as it perfectly describes this specific problem with the solution. I think it's okay to link to this article here, we can remove the link tho if you think so.
Related issues & labels (optional)
github.mdx: The description of the text is discrepancy. #10868