ThreeFold Docs Website
docs_website | ||
build_osx.sh | ||
build_ubuntu.sh | ||
build.sh | ||
install_osx.sh | ||
install_ubuntu.sh | ||
install.sh | ||
LICENSE | ||
README.md | ||
run_osx.sh |
ThreeFold Docs Website
Table of Contents
Introduction
This repository contains the code to the ThreeFold Docs website.
URL
The website is hosted at docs.threefold.io
.
Branches
development
- code version of website
development_<suffix>
- See
Contribute
section for details
- See
Ops Scripts
To install the prerequisites to build the website, you can use the install.sh
script.
To build the website, you can use the build.sh
script.
Deploy and Test Locally
To deploy and test locally, refer to this documentation.
Contribute
To optimize updates to this repository, we propose a uniform way to collaborate.
Branches and Forks
To contribute to this repository, make a pull request of your changes. There are two main methods.
- Fork the repository and make a pull request with your changes
- If you have access, create a new branch in this repo and make a pull request with your changes
Overview
- The production-ready content is published on the development branch
- Any changes to development must go through a pull request (PR) and its associated review from a different branch with the prefix
development_
.- The name of the branch should indicate the work being done, e.g. working on the readme,
development_readme_work
- The name of the branch should indicate the work being done, e.g. working on the readme,
References
This website is written with Docusaurus.