Skip to content

Commit 83fc51d

Browse files
authored
Rewrite README about branches (#1711)
The old docs for branches were quite out of date. This changes them to reflect how they work now.
1 parent 8d0a09e commit 83fc51d

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.asciidoc

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -220,19 +220,24 @@ You can add a new repository under the `repos` section, if it
220220
doesn't already exist, and you can add a new "book" under the
221221
`contents` section.
222222

223-
The `repos.$NAME.branches[]` key lists all of the branches which
224-
should be built -- all of these branches will be available on the
225-
website -- while `repos.$NAME.current` lists the branch which
226-
should be used as the default version on the site.
227-
228-
NOTE: The `branches` and `current` settings can be overridden in
229-
the config for each book. For instance, the "Community Clients"
230-
docs are built only from the `master` branch.
231-
232-
When you release a new version of your code, you need to add
233-
a new `branch` to the config and to update the `current` branch
234-
for your project. Commit the change to https://github.com/elastic/docs/blob/master/conf.yaml[`conf.yaml`] and push
235-
to the remote `docs` repo.
223+
Each book contains a list of `branches` and we build a separate copy of each
224+
book for each of those `branches`. There is also a `current` branch which gets
225+
special treatment. When we fork a branch like like 7.x or 7.9 we typically add
226+
it to the list of `branches` so we immediately start building docs for it while
227+
we're actively developing against it. When we release a new minor or major
228+
version we update the `current` branch to point to that branch.
229+
230+
NOTE: At this point changing `current` requires a full "rebuild" which we do
231+
by logging into the docs
232+
https://elasticsearch-ci.elastic.co/view/Docs/job/elastic+docs+master+build/[build]
233+
clicking the "Build with Parameters" link, checking the "rebuild" option, and
234+
then starting the build.
235+
236+
Each book may optionally contain a list of `live` branches. If the list is
237+
specified only branches that are in it are considered "living" and books that
238+
are not in the list will get a message at the top of each page saying that we
239+
don't plan to release any more bug fixes or actively maintain the docs for that
240+
branch.
236241

237242
[[asciidoc-guide]]
238243
= Asciidoc Guide

0 commit comments

Comments
 (0)