You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-8Lines changed: 12 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,20 +8,24 @@ The generated JSON Schema documentation for the Devfile 2.x is available here: h
8
8
9
9
## Contributing
10
10
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:
12
17
13
18
```bash
14
19
yarn install; yarn run generate-api-reference
15
20
antora antora-playbook.yml
16
21
```
17
22
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.
19
25
20
26
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.
22
28
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.
25
29
26
30
# Issue tracking repo
27
31
@@ -58,7 +62,7 @@ Set the new branch to be specific to the release version. For example, if the re
58
62
attributes:
59
63
prod-ver: 2.0
60
64
```
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:
0 commit comments