Skip to content

Commit 89aab0d

Browse files
authored
Update README.adoc
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.
1 parent ed76385 commit 89aab0d

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.adoc

Lines changed: 15 additions & 5 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&feature=shared
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 on 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,7 +24,15 @@ 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 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
2536

2637
Execute the following steps:
2738

@@ -42,7 +53,6 @@ To build the web site locally, make sure following the prerequisites listed belo
4253
* https://docs.antora.org/antora-ui-default/prerequisites/[UI building prerequisites]
4354
* https://www.npmjs.com/package/@antora/lunr-extension[Lunr extension installation]
4455
====
45-
4656
== Contribute to the documentation
4757

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

Comments
 (0)