Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 3.98 KB

README.md

File metadata and controls

103 lines (77 loc) · 3.98 KB
Raw

Ondat Platform Documentation

Documentation Rendering Lint and Link Checking

This repository contains the Ondat Markdown documentation content published here. The documentation is readable directly out of this repository without needing any extra rendering steps.

The main branch is the latest version of the documentation and is automatically pushed to https://docs.ondat.io.

Contribute

Feel free to contribute! We love feedback and interaction with the Community ;)

The below how-to assumes a general knowledge of Git and GitHub or similar services. If you are new to Git and GitHub, refer to the introduction here.

How-to

  • Fork the repository
  • Clone the forked repository from your GitHub account:

git clone [email protected]:ondat/documentation.git

Cloning into 'documentation'...
remote: Enumerating objects: 860, done.
remote: Counting objects: 100% (860/860), done.
remote: Compressing objects: 100% (628/628), done.
remote: Total 860 (delta 448), reused 603 (delta 215), pack-reused 0
Receiving objects: 100% (860/860), 87.45 MiB | 1.37 MiB/s, done.
Resolving deltas: 100% (448/448), done.
Updating files: 100% (274/274), done.
  • Create a branch like "new-use-case" or "fixing-type-in-rancher-installation":

git checkout -b new-use-case

  • Create the new content using Markdown and include the header defining title and link as shown below
cat docs/usecases/argocd.md
---
title: "ArgoCD"
linkTitle: "ArgoCD"
---

ArgoCD rocks!
  • Commit the content and push it:

git add --all . && git commit -m "adding a new use case about ArgoCD"

[new-use-case f20b38f] adding a new use case about ArgoCD
 1 file changed, 7 insertions(+)
 create mode 100644 docs/usecases/argocd.md

git push --set-upstream origin new-use-case

Enumerating objects: 8, done.
Counting objects: 100% (8/8), done.
Delta compression using up to 12 threads
Compressing objects: 100% (5/5), done.
Writing objects: 100% (5/5), 446 bytes | 446.00 KiB/s, done.
Total 5 (delta 3), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (3/3), completed with 3 local objects.
remote:
remote: Create a pull request for 'new-use-case' on GitHub by visiting:
remote:      https://github.com/ondat/documentation/pull/new/new-use-case
remote:
To github.com:ondat/documentation.git
 * [new branch]      new-use-case -> new-use-case
Branch 'new-use-case' set up to track remote branch 'new-use-case' from 'origin'.
  • Create a Pull Request and document your contribution and
  • an Ondat team member will review your PR contribution and merge it

How to render the docs locally

  • Install hugo extended from the hugo release page, for instance the hugo_extended_0.92.1_macOS-ARM64.tar.gz
  • Clone the documentation-backend: git clone https://github.com/ondat/documentation-backend.git
  • Create symbolic links for the content into the backend directory:
PATH_TO_DOCS_SOURCE=/path/to/the/source/of/docs
PATH_TO_DOCS_BACKEND=/path/to/the/backend/repo
rsync -az $PATH_TO_DOCS_SOURCE/docs/ $PATH_TO_DOCS_BACKEND/hugo-backend/content/docs
rsync -az $PATH_TO_DOCS_SOURCE/sh/ $PATH_TO_DOCS_BACKEND/hugo-backend/static/sh
rsync -az $PATH_TO_DOCS_SOURCE/yaml/ $PATH_TO_DOCS_BACKEND/hugo-backend/static/yaml
rsync -az $PATH_TO_DOCS_SOURCE/images/docs/ $PATH_TO_DOCS_BACKEND/hugo-backend/static/images/docs
rsync -az $PATH_TO_DOCS_SOURCE/images/generic/ $PATH_TO_DOCS_BACKEND/hugo-backend/static/images/generic
  • Go to documentation-backend/hugo-backend and run hugo server -D --config config/latest.toml
  • Open a browser to http://127.0.0.1:1313