rancherfederal / hauler-docs

Rancher Government Hauler Docs

Local Development

Installing Dependencies (docusaurus)

git clone https://github.com/rancherfederal/hauler-docs
cd hauler-docs

# install docusaurus & dependencies from package.json
npm install # make sure you are in the root of the dir containing `package.json`
# yarn install # if npm install did not work

# test the installation
npx docusaurus --version

Deploy Locally

# this will open your default browser to http://localhost:3000
npm run start

Creating Content

Official Docusaurus Documentation

Publishing Content

This docs site is served using github-pages. There is an action that will trigger upon commit to the main branch and deploy the new build to https://hauler.dev (https://rancherfederal.github.io/hauler-docs).

Contributing

• Fork this Repository
• Make your Changes
• Commit changes and Reference the Issue
• Submit Pull Request with Changes