Skip to content

Commit 4aa2de5

Browse files
authored
Merge pull request #50 from LabVIEWCommunityTraining/unifab-patch-1
Update README.adoc
2 parents 7027511 + 3a7c05f commit 4aa2de5

File tree

1 file changed

+22
-7
lines changed

1 file changed

+22
-7
lines changed

README.adoc

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,20 @@
22

33
This is a multilingual repository to host all of the documentation for the LabVIEW Community Training Initiative.
44

5+
== Videos
6+
Playlist: https://youtube.com/playlist?list=PLZ3A_SIOKdQufue8kHC7eMlZdgAD1tzZv
7+
58
== Building and publishing the site
69

7-
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.
811
See the `Actions` tab for details.
912

1013
== Documentation Versioning and Branching Workflow
1114

1215
Versioning of the documentation relies on branches.
1316
Each version of the documentation stands in branches called `vx.y`.
1417

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.
1619

1720
== Creating a New Version
1821

@@ -21,11 +24,24 @@ NOTE: There's no need to merge those `vx.y` in main. The build and publish actio
2124

2225
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.
2326

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
2541

2642
Execute the following steps:
2743

28-
. Building the web site UI:
44+
. Building the website UI:
2945
* Open a terminal in the `user-interface` folder.
3046
* Execute the following command `npx gulp bundle`
3147
. Build the website.
@@ -36,13 +52,12 @@ Once built, the website is available in the `/antora/build/sites/en` folder.
3652

3753
[IMPORTANT]
3854
====
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:
4056
4157
* https://docs.antora.org/antora/latest/install-and-run-quickstart/[Antora install]
4258
* https://docs.antora.org/antora-ui-default/prerequisites/[UI building prerequisites]
4359
* https://www.npmjs.com/package/@antora/lunr-extension[Lunr extension installation]
4460
====
45-
4661
== Contribute to the documentation
4762

48-
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

Comments
 (0)