rancher
/
turtles-docs
mirror of https://github.com/rancher/turtles-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Rancher Turtles project documentation
266 Commits 26 Branches 24 Tags 24 MiB
JavaScript 82.7%
SCSS 6.6%
Less 6%
CSS 4.2%
Go 0.2%
Other 0.2%
Go to file
Carlos Salas 4af220ea9d
Merge pull request #171 from alexander-demicev/devdocs 
Update dev and architecture sections
 		2024-10-31 11:08:48 +01:00
.github/workflows add label on new version pr 2024-10-28 16:32:36 +01:00
blog docs: update the slack channel 2023-10-10 18:36:57 +02:00
docs Update architecture section with newest changes 2024-10-30 16:51:09 +01:00
hack
…
src Updating with merge confict fixed. 2024-03-15 17:07:24 -07:00
static
…
versioned_docs Add docs version v0.13 2024-10-28 11:23:13 +00:00
versioned_sidebars Add docs version v0.13 2024-10-28 11:23:13 +00:00
.gitignore docs: add instructions for early adopters 2024-04-02 14:25:15 +01:00
CNAME Adding the updated URL schema for Rancher Turtles documentation in the config and the CNAME file. Additionally updated links that were throwing errors while attempting yarn start. 2024-03-15 17:16:31 -07:00
LICENSE
…
Makefile
…
README.md Add description of how the docs are versioned 2023-10-09 15:29:55 +02:00
babel.config.js
…
docusaurus.config.js Fix editUrl 2024-05-31 16:43:35 -07:00
package.json Adding local search functionality which supports text highlighting, and multiple languages if zh translations are added in the future. Additionally, removed the ts-check from the config as it was erroring with the new theme addition. 2024-04-11 08:40:42 -07:00
sidebars.js Merge pull request #158 from Danil-Grigorev/clusterctlconfig-docs 2024-09-26 11:17:10 +02:00
versions.json Add docs version v0.13 2024-10-28 11:23:13 +00:00
yarn.lock Adding local search functionality which supports text highlighting, and multiple languages if zh translations are added in the future. Additionally, removed the ts-check from the config as it was erroring with the new theme addition. 2024-04-11 08:40:42 -07:00

README.md

Rancher Turtles Documentation

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

This project follows docusaurus versioning guidelines, including the process of archiving the old versions.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.