-
Notifications
You must be signed in to change notification settings - Fork 66
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
Book evolution in main Bevy repository #70
Open
mockersf
wants to merge
3
commits into
bevyengine:main
Choose a base branch
from
mockersf:book-evolution-in-main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# Feature Name: `book_evolution_in_main` | ||
|
||
## Summary | ||
|
||
Reduce the cost of starting the book, and of ongoing book evolution with new versions of Bevy. | ||
|
||
## Motivation | ||
|
||
I want the Bevy Book to get better faster. We've tried to make it evolve in bevy-website repository, but getting to a publishable state means getting the content, the CI and the formatting ready all at once and lead to a long lived `new-book` branch that is in limbo. The current approach would also mean that for a new version of Bevy, we would have to pull a new branch, make it use the next version of Bevy, update everything, then merge it back on the website for publication. I fear this will make the release process longer. | ||
|
||
I'm opening this as a RFC as it has moving parts across 2 repositories, and it's an evolution on [RFC #23: Quick Start Book](https://github.com/bevyengine/rfcs/blob/main/rfcs/23-quick_start_book.md). | ||
|
||
## User-facing explanation | ||
|
||
As a user wanting to contribute to the book, I can do so on the Bevy main repository. | ||
|
||
## Implementation strategy | ||
|
||
- Add a new folder in Bevy main repository for the book | ||
- Start accepting contributions for it, with the layout / rules from [RFC #23: Quick Start Book](https://github.com/bevyengine/rfcs/blob/main/rfcs/23-quick_start_book.md) | ||
- Set up main repository CI to check that the book content is up to date with the code | ||
- For new book PRs, this should be blocking | ||
- For new code PRs, this should be a non blocking CI. Writing or updating the book can be delegated to another issue that will be added to the next milestone | ||
- Set up bevy-website repository CI to pull the book content from the latest tag and publish it | ||
|
||
## Drawbacks | ||
|
||
🤷 | ||
|
||
More non code commits in the main repo maybe? But I think that's good as it gives better visibility to book contributions. The main repo will also gets larger which can slow down checkout / clones. | ||
|
||
## Rationale and alternatives | ||
|
||
- It allows us to start writing the book without worrying it about being public directly, or working in a long lived branch | ||
- This keeps the book versioning in check with Bevy | ||
|
||
## Future possibilities | ||
|
||
- Publish the book content as part of the rust doc (a `bevy_book` crate?) | ||
- Publish the book content with versioning | ||
mockersf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Remove `/docs/` in the main repo and migrate all of that content to the Bevy book |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How are these PR types distinguished? If it modifies any code in that folder at all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if the build fail: