2024-08-26 19:41:55 +00:00
|
|
|
<h1> ThreeFold Docs Website </h1>
|
|
|
|
|
|
|
|
|
|
<h2>Table of Contents</h2>
|
|
|
|
|
|
|
|
|
|
- [Introduction](#introduction)
|
|
|
|
|
- [URL](#url)
|
|
|
|
|
- [Branches](#branches)
|
2024-10-16 14:51:41 +00:00
|
|
|
- [Ops Scripts](#ops-scripts)
|
|
|
|
|
- [Deploy and Test Locally](#deploy-and-test-locally)
|
2024-08-26 19:41:55 +00:00
|
|
|
- [Contribute](#contribute)
|
|
|
|
|
- [Branches and Forks](#branches-and-forks)
|
|
|
|
|
- [Overview](#overview)
|
|
|
|
|
- [References](#references)
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
## Introduction
|
2024-08-25 19:21:59 +00:00
|
|
|
|
|
|
|
|
This repository contains the code to the ThreeFold Docs website.
|
|
|
|
|
|
2024-08-26 19:41:55 +00:00
|
|
|
## URL
|
|
|
|
|
|
2024-11-15 16:15:29 +00:00
|
|
|
The website is hosted at `docs.threefold.io`.
|
2024-08-25 19:21:59 +00:00
|
|
|
|
|
|
|
|
## Branches
|
|
|
|
|
|
|
|
|
|
- `development`
|
|
|
|
|
- code version of website
|
2024-08-26 19:41:55 +00:00
|
|
|
- `development_<suffix>`
|
|
|
|
|
- See `Contribute` section for details
|
2024-08-26 19:38:35 +00:00
|
|
|
|
2024-10-16 14:51:41 +00:00
|
|
|
## 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](./docs_website/README.md).
|
|
|
|
|
|
2024-08-26 19:38:35 +00:00
|
|
|
## 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.
|
|
|
|
|
|
|
|
|
|
1. Fork the repository and make a pull request with your changes
|
|
|
|
|
2. 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_`.
|
2024-08-26 19:41:55 +00:00
|
|
|
- The name of the branch should indicate the work being done, e.g. working on the readme, `development_readme_work`
|
|
|
|
|
|
|
|
|
|
## References
|
|
|
|
|
|
|
|
|
|
This website is written with [Docusaurus](https://docusaurus.io/).
|
