This is a multilingual repository to host all of the documentation for the LabVIEW Community Training Initiative.
The site is built and published automatically after a push on the repository is done.
See the Actions tab for details.
Versioning of the documentation relies on branches.
Each version of the documentation stands in branches called vx.y.
|
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.
|
-
Create a new
vx.ybranch starting from the most recent branch version. -
Update the
version:attribute of eachcti-doc_xx/content/antora.ymlandcti-doc_xx/home/antora.ymlfiles according to the version name.
|
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.
|
We recommend either one of these two options for people working more intensely in this repository
-
Clone the repository or Download a zip of the source files
-
Install Community Edition for Intelli J https://www.jetbrains.com/idea/download/#community-edition (We can use it for this Open Source project)
-
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
Execute the following steps:
-
Building the web site UI:
-
Open a terminal in the
user-interfacefolder. -
Execute the following command
npx gulp bundle
-
-
Build the website.
-
Open a Terminal in the
antorafolder. -
execute the following command
npx antora --ui-bundle-url ../user-interface/build/ui-bundle.zip --url <absolute path to your local repository> --to-dir build/sites/en antora-playbook-en.yml.
-
Once built, the website is available in the /antora/build/sites/en folder.
|
Important
|
To build the web site locally, make sure following the prerequisites listed below: |
Please follow the instructions available here to contribute to the documentation.