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
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 to 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,11 +24,24 @@ 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 three options for people working more intensely in this repository
29
+
30
+
=== Use Visual Studio
31
+
* Install the Asciidoc extension
32
+
* On the settings, make sure to go under Asciidoc > Antora: Show Enable Antora Prompt, and check "Show a prompt to enable Antora support when an antora.yml file is detected"
33
+
** For this prompt to work, you need to have a single antora.yml on your folder, so open at the language folder level you are working on
34
+
35
+
=== Use Intelli J to render locally
36
+
* Clone the repository or download a zip of the source files
37
+
* Install Community Edition for Intelli J https://www.jetbrains.com/idea/download/#community-edition (We can use it for this Open Source project)
38
+
* 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
39
+
40
+
=== Building the site locally
25
41
26
42
Execute the following steps:
27
43
28
-
. Building the web site UI:
44
+
. Building the website UI:
29
45
* Open a terminal in the `user-interface` folder.
30
46
* Execute the following command `npx gulp bundle`
31
47
. Build the website.
@@ -36,13 +52,12 @@ Once built, the website is available in the `/antora/build/sites/en` folder.
36
52
37
53
[IMPORTANT]
38
54
====
39
-
To build the web site locally, make sure following the prerequisites listed below:
55
+
To build the website locally, make sure to follow the prerequisites listed below:
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.
63
+
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