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
Updated the README with the link to the playlist that shows Tim and I doing a modification to an existing Asciidoc file, doing a pull request, and reviewing that pull request.
I also added an alternative for previewing the pages by installing the community edition of Intelli J. This will be the first option for rendering locally and left the option of rendering the Antora website locally as a second option.
The site is built and published automatically as soon as a push on the repository is done.
10
+
The site is built and published automatically after a push on the repository is done.
8
11
See the `Actions` tab for details.
9
12
10
13
== Documentation Versioning and Branching Workflow
11
14
12
15
Versioning of the documentation relies on branches.
13
16
Each version of the documentation stands in branches called `vx.y`.
14
17
15
-
NOTE: There's no need to merge those `vx.y` in main. The build and publish action is triggered on any `vx.y` branch push.
18
+
NOTE: There's no need to merge that ' vx.y` in the main branch. The build and publish action is triggered on any `vx.y` branch push.
16
19
17
20
== Creating a New Version
18
21
@@ -21,7 +24,15 @@ NOTE: There's no need to merge those `vx.y` in main. The build and publish actio
21
24
22
25
TIP: You can add a `prerelease:` attribute to suffix the version name as long as the content is not ready for an official release. The version will be accessible on the website, but it will not be displayed as the default version to the visitor.
23
26
24
-
== Building the site locally
27
+
== Rendering pages on your computer
28
+
We recommend either one of these two options for people working more intensely in this repository
29
+
30
+
=== Use Intelli J to render locally
31
+
* Clone the repository or Download a zip of the source files
32
+
* Install Community Edition for Intelli J https://www.jetbrains.com/idea/download/#community-edition (We can use it for this Open Source project)
33
+
* When you open the CTI-Documentation folder, as soon as you open the first Asciidoc file, it will prompt you to install the Asciidoc plug in
34
+
35
+
=== Building the site locally
25
36
26
37
Execute the following steps:
27
38
@@ -42,7 +53,6 @@ To build the web site locally, make sure following the prerequisites listed belo
42
53
* https://docs.antora.org/antora-ui-default/prerequisites/[UI building prerequisites]
Please follow the instructions available https://labviewcommunitytraining.github.io/cti-documentation/en/cti-doc/contributing.html#contributing-to-the-documentation[here] to contribute to the documentation.
58
+
Please follow the instructions available https://labviewcommunitytraining.github.io/cti-documentation/en/cti-doc/contributing.html#contributing-to-the-documentation[here] to contribute to the documentation.
0 commit comments