|
@@ -101,7 +101,7 @@ The wiki uses branches for versioning. The current branch being used for the jMo
|
|
|
|
|
|
The `docs` module is the main module for the wiki. Its `antora.yml` file controls the version of the wiki. The playbook uses this version to create the folders inside the `gh-pages` branch, building the content from the branches configured in the playbook.
|
|
|
|
|
|
-Branch version names should only target major/minor releases, not the patch of a version and start with "`v`".
|
|
|
+Branch version names should only target major/minor releases, not the patch of a version, and start with "`v`".
|
|
|
|
|
|
When it's time to cut a new version for the wiki, the process is as follows.
|
|
|
|
|
@@ -120,7 +120,7 @@ add: "package-lock.json package.json ./.cache/antora/*"
|
|
|
. If you didn't remove the cache during step one, delete it from the newly created branch.
|
|
|
. Push the branch to the repository.
|
|
|
. On the `master` branch, edit these files:
|
|
|
-.. Add the newly created branch to the `branches:` array in wiki-playbook.yml.
|
|
|
+.. Add the newly created branch to the `branches:` array in `wiki-playbook.yml`.
|
|
|
+
|
|
|
.wiki-playbook.yml
|
|
|
```
|
|
@@ -129,7 +129,7 @@ content:
|
|
|
- url: https://github.com/jMonkeyEngine/wiki.git
|
|
|
branches: [HEAD, v3.3, v3.2]
|
|
|
```
|
|
|
-.. Increment the version of the antora.yml file.
|
|
|
+.. Increment the version of the `antora.yml` file.
|
|
|
+
|
|
|
--
|
|
|
.The docs antora.yml
|
|
@@ -192,7 +192,8 @@ The master branch `Antora.yml` file is using 3.4.
|
|
|
|
|
|
...
|
|
|
----
|
|
|
-Edit the `jmonkeyengine.json` file and push your commit to update the search. It takes aproximately 24hrs after the commit is merged for it to take affect.
|
|
|
+Edit the `jmonkeyengine.json` file and push your commit to update the search. It takes approximately 24hrs after the commit is merged for it to take effect.
|
|
|
+
|
|
|
.Updated jmonkeyengine.json
|
|
|
[source, .json]
|
|
|
----
|