SteveLasker / rkvst-docs

Repo for the new RKVST Docs home

RKVST Documentation

This is the Home of the RKVST Documentation.

RKVST provides Provenance as a Service to attest trustworthiness of Assets and boost confidence in digital decisions. Find out more on our website.

Contributing

To contribute to these Docs, please refer to our Contributing Guidelines.

We'll happily review any suggestions!

Getting Started

1. To begin, pull the latest RKVST docs from Github.

git clone [e-mail]:rkvst/rkvst-docs.git

2. Move into the directory.

cd rkvst-doks

3. Install the DOKS Dependencies.

npm install

4. To run a local RKVST Docs Server, it is advisable to use the rkvst-doks wrapper.

rkvst-doks start

This will build a local version of the server that can be accessed at http://localhost:1313.

Credits

This Documentation was put together using some amazing opensource tools and projects; this is a list of known projects included but is not exhaustive.

• The wonderful Doks Theme. License: MIT
• Built on top of Hugo. License: Apache License 2.0
• With inspiration and examples from the Kubernetes Docs. License: CC BY-SA 4.0
• Screenshotting dynamically handled by the Robot Framework using the Selenium2 package. Licenses: Apache License 2.0 and Apache License 2.0 respectively
• Hosted by GitHub Pages and built using GH Actions