Skip to content

Commit 94915f2

Browse files
committed
Add a description of how the reference is published
This adds a description of how the reference gets published. Closes #38
1 parent 89f67b3 commit 94915f2

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,19 @@
11
# The Rust Language Reference
22

3-
This document is the primary reference for the Rust programming
4-
language.
3+
This document is the primary reference for the Rust programming language.
4+
5+
## How is this published?
6+
7+
The process for getting the reference content into a [Rust release](https://doc.rust-lang.org/reference/#rust-releases) and on the website is:
8+
9+
1. Changes are merged to this repository.
10+
2. [Triagebot](https://forge.rust-lang.org/triagebot/doc-updates.html) will automatically synchronize this repository to [rust-lang/rust]. This happens every other week. The reference is tracked in [rust-lang/rust] as a [submodule](https://github.com/rust-lang/rust/tree/master/src/doc).
11+
- If more frequent updates are desired, the bot can be poked via Zulip to do a sync immediately.
12+
- This will open a PR on [rust-lang/rust] which needs to be merged, and that can take up to several days.
13+
3. At midnight UTC, whatever is on the default branch of [rust-lang/rust] will be a part of that nightly release, and will be published after a few hours to <https://doc.rust-lang.org/nightly/reference/>.
14+
4. Following Rust's [release process](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html), every 6 weeks, nightly will be promoted to beta (<https://doc.rust-lang.org/beta/reference/>), and then 6 weeks after that it will be promoted to stable (<https://doc.rust-lang.org/stable/reference/>).
15+
16+
[rust-lang/rust]: https://github.com/rust-lang/rust/
517

618
## Dependencies
719

0 commit comments

Comments
 (0)