Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-26 02:11:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

re-arrange the user docs (#76)

Browse Source 
* re-arrange the user docs

* Minor description edit

* update styles

* fix service links

Co-authored-by: kn0wmad <kn0wmad@protonmail.com>
Co-authored-by: Lucy Cifferello <12953208+elvece@users.noreply.github.com>
This commit is contained in:
Matt Hill
2022-02-18 08:49:53 -07:00
committed by GitHub
parent c38d5c1a0c
commit aed86e7e6c
151 changed files with 500 additions and 781 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -50,27 +50,21 @@ git clone https://github.com/Start9Labs/documentation.git && cd documentation
git submodule update --init
```
3. (Optional, if you have an older build that needs to be updated) Navigate to `sphinx-scylladb-theme`, update and build with:
```
cd sphinx-scylladb-theme
git pull
npm i
npm run build
```
4. Navigate to the `site` folder and start the project:
3. Navigate to the `site` folder and start the project:
```
cd site
make clean && make preview
```
## Development
When editing these files, begin a livereload environment by running `make preview` while in the `./site/` directory.
When editing any css or table of contents organization changes, the livereload environment must be ended and `make clean` run before starting `make preview` again.
If you edit something inside `sphinx-scylladb-theme`, you will need to `cd` into that directory and run `npm run build`.
### Versioning
- Build for versioning (must be on master) branch: `make multiversion`
- To view version metadata: `make multiversionpreview`