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
Integration of new WIP Bevy Book #624
Closed
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change introduces the minimal amount of changes to accomplish the following: - Old "book" is now Quick Start - New book has a initial version (v0.11.0) with one page - A link which defaults to being hidden has been added to the list of links on /learn
- This incorporates changes from 97fef72, which is latest commit on new-book branch - Smallest amount of changes to get the overall book structure change - Various styling / minor fixes most probably missing from new-book - These can be applied later, right now a lot of conflicts so defer - Redirects properly setup to go the first section Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
This is a temporary measure in order to stop Google et al from indexing the book before a first version been finalized. Pages within the book won't show up in any search results and can only be accessed by direct URL access for now.
Taken from summarizing bevyengine#623
Added to the bottom of the Book section list on the left. - Reads versions from `content/learn/book/versions.toml` so we can start working on the book for a new version and have the content in `main` without neccessarly publishing it on the website
Pages that been checked to redirect correctly: https://bevyengine.org/learn/book/introduction/ https://bevyengine.org/learn/book/getting-started/ https://bevyengine.org/learn/book/getting-started/setup/ https://bevyengine.org/learn/book/getting-started/apps/ https://bevyengine.org/learn/book/getting-started/ecs/ https://bevyengine.org/learn/book/getting-started/plugins/ https://bevyengine.org/learn/book/getting-started/resources/ https://bevyengine.org/learn/book/next-steps/ https://bevyengine.org/learn/book/contributing/ https://bevyengine.org/learn/book/contributing/code/ https://bevyengine.org/learn/book/contributing/docs/ https://bevyengine.org/learn/book/troubleshooting/ Everything should redirect properly from: https://bevyengine.org/learn/book/* To: https://bevyengine.org/learn/quick-start/*
6 tasks
For other reviewers: you can check the content of the new book at http://127.0.0.1:1111/learn/book/v0.11.0/welcome/ once your local copy of zola is serving this PR. |
Site builds successfully for me, and the existing book works. New book also appears to be functional. Concerns:
|
Closing this PR until versioning discussion over at #623 been resolved, and future PRs will be split up commit-by-commit instead |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the result of the discussion in #623
In short, it implements the following:
It was made in 7 separate commits for each one of the above (+ 1 to fix markdownlint issues), and is best reviewed commit by commit as to not be overwhelmed:
Minimal changes to add hidden book (b20d68e)
Pull in book structure from
new-book
(6bd3b5d)Disallow indexing of new book (b2b1178)
First draft of Contribution Guidelines for Bevy Book (b81dc3c)
First version of a version picker for Bevy Book (af2dac4)
Address markdownlint issues (036aa49)
Redirect everything from /learn/book/* to /learn/quick-start/* (a9e39ea)
@alice-i-cecile @cart as mentioned in the issue, the idea here is to get something basic in place that can go into
main
asap so we can begin to iterate on the book contents and everything else from a common base, instead of long-lived branches and PRs.