The sources of this tutorial docs is in documentation folder. The site generation is done by Antora
If you are using Visual Studio Code with the Remote Containers Extension, you don’t need to install anything locally.
Simply follow these instructions:
-
(Only if running with podman) Set the environment variable
DEVCONTAINER_TARGET_PREFIX=podman
-
Open VS Code from the root of
openshift-starter-guides
repository and when prompted indicate that you want to open the folder in a container.
Once the devcontainer is initialized, from the Visual Studio Code terminal run npm run dev
to start the development site. (Visual Studio Code should handle all the port forwarding into the devcontainer so that you can interact with the site from an VSCode assigned port on your localhost)
Alternatively, you can run the Build and watch dev-site
VSCode task that should be installed in your workspace when starting up the container
To run the site in development mode you need to have yarn or npm installed with NodeJS v12.x or above.
Clone this repository
git clone https://github.com/redhat-scholars/openshift-starter-guides.git
Run yarn install
or npm install
from the openshift-starter-guides
repository to install needed nodejs packages.
npm install
Start the development site using yarn run dev
or npm run dev
or gulp
command, this should open a local development site at http://localhost:3000 in your default browser:
gulp
Making any changes to your local repositories above cloned earlier, will be automatically built and the development site gets reloaded automatically.
Now you are all set:
-
Open an Issue in http://github.com/redhat-scholars/openshift-starter-guides.git
-
Prepare your changes in the respective documentation repository
-
Send the PR to respective repositories listed above