Skip to content

Commit 868daf4

Browse files
authored
Update readme for multi version (#40)
* add contributing info for multi-release * Update README for multi-version support
1 parent d71deb0 commit 868daf4

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,24 @@ The generated JSON Schema documentation for the Devfile 2.x is available here: h
88

99
## Contributing
1010

11-
To build the documentation locally you need [Antora](https://antora.org/), node v10.12 or higher and yarn. Then from the root of this repository run:
11+
The repository contains multiple versions of the documentation, so be sure to modify and test the version of the documentation for your contribution.
12+
* For the latest version, use the master branch.
13+
* For a previous version, use the ```v<n>.<m>.x``` branch where `n` is the major version of the release, and `m` is the minor version. For example, ```v2.0.x```.
14+
* Be sure when merging any changes for a previous release to merge into the correct branch and not master.
15+
16+
Build is the same for each branch. To build the documentation locally, you need [Antora](https://antora.org/), node v10.12 or higher, and yarn. Then from the root of this repository, run:
1217

1318
```bash
1419
yarn install; yarn run generate-api-reference
1520
antora antora-playbook.yml
1621
```
1722

18-
These commands will generate the html documentation in folder `build/site`. Open `build/site/index.html` in the browser.
23+
These commands generate the html documentation in folder `build/site`. Open `build/site/index.html` in the browser. However, note that the build
24+
may build multiple versions of the documentation, so be sure to select and view the version you are editing when viewing in the browser.
1925

2026
Additionally, when pushing to a branch or working on a PR, the site is built by a GH action and
21-
made available in a ZIP file as a GH action build artifact, and can be tested locally.
27+
made available in a ZIP file as a GH action build artifact and can be tested locally.
2228

23-
* Updates to the documentation for the Devfile version under development should be merged into the master branch.
24-
* Updates to the documentation for previously released Devfile versions should be merged into the braach for the release version, for example v2.0.x.
2529

2630
# Issue tracking repo
2731

@@ -58,7 +62,7 @@ Set the new branch to be specific to the release version. For example, if the re
5862
attributes:
5963
prod-ver: 2.0
6064
```
61-
1. Modify .gitignore to not ignore the doc generated from the schema for the release:
65+
1. Modify .gitignore to ignore the doc generated from the schema which are not for the release:
6266
```
6367
docs/modules/user-guide/attachments/api-reference/next
6468
docs/modules/user-guide/attachments/api-reference/stable
@@ -101,7 +105,7 @@ from the newly created ```v.2.0.x``` branch.
101105
version: '2.1.0'
102106
prerelease: -alpha
103107
```
104-
1. Modify `antora-playbook.yaml` to add content for the new release created (if not already covered by branch pattern ```v2.0.*```:
108+
1. Modify `antora-playbook.yaml` to add content for the new release created (if not already covered by branch pattern ```v2.*```:
105109
```
106110
content:
107111
sources:
@@ -117,4 +121,4 @@ from the newly created ```v.2.0.x``` branch.
117121
118122
119123
120-
124+

0 commit comments

Comments
 (0)