Go to file

Sunil Singh 506c50868a Merge pull request #77 from sunilarjun/sync-community Sync Community and Product		2025-10-22 08:24:25 -07:00
.github	Updating the test deploy workflow to include build status.	2025-10-01 12:40:29 -07:00
bin	Adding switch-prod-comm script and adding necessary antora-yml folders with related version antora files.	2025-10-01 11:58:22 -07:00
dsc-style-bundle@58597dae23	Bump dsc-style-bundle from `92cf9c0` to `58597da`	2025-10-16 20:12:56 +00:00
product-docs-common@a14d458dd7	Bump product-docs-common from `1b29fdd` to `a14d458`	2025-10-16 20:12:53 +00:00
turtles-supplemental-files	Adding community supplemental_files for build	2025-10-01 11:58:57 -07:00
versions	Merge pull request #77 from sunilarjun/sync-community	2025-10-22 08:24:25 -07:00
.gitignore	Updating structure for multiple versions starting with v0.11.	2024-09-10 14:19:18 -07:00
.gitmodules	Use shared resource for attributes	2025-09-24 17:21:21 -07:00
CODEOWNERS	Use GitHub team as owner instead of individuals	2024-08-30 16:43:52 -07:00
LICENSE	Adding Apache license	2024-09-16 16:00:36 -07:00
Makefile	Updating Makefile to have previews for all build targets with unique ports/updating make env to be prereq for builds.	2025-10-01 15:34:46 -07:00
README.md	Updating README	2024-09-18 12:47:20 -07:00
package-lock.json	Add springio/antora-xref-extension. Antora's built-in validation doesn't support xrefs with fragments (i.e. linking to the header of another file)	2025-01-10 16:04:33 -08:00
package.json	Add springio/antora-xref-extension. Antora's built-in validation doesn't support xrefs with fragments (i.e. linking to the header of another file)	2025-01-10 16:04:33 -08:00
turtles-dev-community-playbook.yml	Adding missing xref validations	2025-10-01 15:36:04 -07:00
turtles-dev-product-playbook.yml	Updating Makefile and adding playbooks for respective product/community builds.	2025-10-01 11:55:01 -07:00
turtles-local-community-playbook.yml	Adding missing xref validations	2025-10-01 15:36:04 -07:00
turtles-local-product-playbook.yml	Updating Makefile and adding playbooks for respective product/community builds.	2025-10-01 11:55:01 -07:00
turtles-remote-community-playbook.yml	Adding build outputs to remote prod/comm playbooks for previewing.	2025-10-01 15:36:41 -07:00
turtles-remote-product-playbook.yml	Adding build outputs to remote prod/comm playbooks for previewing.	2025-10-01 15:36:41 -07:00

README.md

Turtles Product Documentation

Build the Documentation site

The repository uses Antora Playbooks to locally or remotely build the AsciiDoc content into a static website.

Prerequisites

git

You need git to get the source code of this repository. Run the command below to check whether git is installed on your machine.

git --version

If you don't have git installed on your machine, download and install it for your operating system from the git downloads page.

Node.js

Antora requires an active long term support (LTS) release of Node.js. Run the command below to check if you have Node.js installed, and which version. This command should return an active Node.js LTS version number

node -v

If you don't have Node.js installed on your machine, install it, preferably via nvm

Clone the Playbook repository

Run the git command to clone this repository.

git clone https://github.com/rancher/turtles-product-docs.git

This playbook repository uses a git submodule to get the custom Antora supplemental files that provide a custom GUI theme for the documentation website. Run the command below to get the submodule.

git submodule update --init

Install node modules

Open a terminal at the root of the git repository. Run the command below.

npm install

Run Antora to build the static website

As a local example, run the command below to build the site:

npx antora --fetch turtles-local-playbook.yml

Navigate to the ./build/site directory and open the index.html file in your browser to view and navigate the documentation site.

Alternatively, run the below command first and then open http://127.0.0.1:8080/ in your browser for a web server preview:

make preview

Run Antora to build the static website using the local documentation content

The command provided in the previous section fetches documentation content of the products from their respective remote GitHub repositories. If you want the playbook to use the documentation content from your local machine instead you can do so with product-docs-playbook-local.yml.

Clone all the individual product documentation Github repositories one level above the current playbook repository.

As an example, run the command below to use the local turtles-local-playbook.yml file.

npx antora --fetch turtles-local-playbook.yml

Makefile

The Makefile can also be used to set up your environment, build the local and remote static site, and clean your build output directory.

If you are a SUSE Rancher Customer

It is recommended to report the issue via the SUSE Customer Center

If you are a SUSE Internal Employee

It is recommended to file a Jira ticket. If you do not have access to Jira then you can file a GitHub ticket on the respective product documentation repository.