ourworld_web/www_threefold_io
23
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update documentation

Browse Source
This commit is contained in:
timurgordon
2024-04-03 01:32:35 -04:00
parent 7b66d399b5
commit f5baf857d2
7 changed files with 61 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
README.md
View File

@@ -1,69 +1,42 @@
# Welcome to Welcome to ThreeFold Website RepositoryWebsite Repository
# Threefold Website
Official website for Threefold.
![](./static/images/tf_logo.png)
**Administration & Access**
## About
This website is administered by [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin). Publishing changes directly to `development` and `master` branches requires access for repository admins. Please see [contribution procedures](CONTRIBUTING.md) for more information.
The official website of ThreeFold Foundation. <br>
**Deployment**
- Production: [www.threefold.io](https://www.threefold.io) (`master` branch)
- Staging: [www2.threefold.io](https://www2.threefold.io) (`development` branch)
Production: [www.threefold.io](https://www.threefold.io) (master branch)
## Getting started
Staging: www2.threefold.io (development branch)
1. Install `hero` if you don't have it
```bash
curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/installer_hero.sh > /tmp/hero_install.sh
bash /tmp/hero_install.sh
```
Last Updated: May 2023
1. Clone repository
## Administrators
[ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin)
2. edit content or playbook
## Contribution Procedure
3. run playbook to preview website in browser
![readme](https://user-images.githubusercontent.com/43240801/236867088-56c95abd-510c-4202-b0c5-317cdfb75cb3.png)
`hero zola -u https://github.com/threefoldfoundation/www_threefold_io/tree/development_zola/playbook` or `bash start.sh`
It is highly important to follow this procedure to contribute to the website content. <br>
__WARNING__: DO NOT commit straight into the __master__ / __development__ branches.
1. Feel free to [create a new issue](https://github.com/threefoldfoundation/www_threefold_io/issues/new) to report an error on the website, or if you have any suggestions on website improvements.
2. Make your own branch from the __development__ branch. By creating a new branch from __development__ you will be provided with the latest copy of the live website content at the staging site, www2.threefold.io.
3. Add your edits into your own branch via code editor locally, and push your local changes online. WARNING: DO NOT add your edits straight into __master__ / __development__ branch.
5. Create a PR to merge your own branch into **development**, and assign one of [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) on your PR as reviewer, or assign @sasha-astiadi as reviewer.
7. When PR is approved, you can see your changes on staging env on www2.threefold.io (development branch)
8. Admin will then create a PR to merge **development** into into **master** (production branch)
10. When PR is approved, you can see your changes live on production www.threefold.io (master branch).
4. save and publish changes
## Development
While contributing content to this site doesn't strictly require setting up a development environment, it will allow you to preview your changes and that's super handy.
This website is built with `hero`, using `zola` under the hood.
To do that, the following prerequisites are needed:
Please see
* macOS or Linux
* [Zola](https://www.getzola.org/documentation/getting-started/installation/)
Then clone the repository recursively to also pull in contents of `threefold_data`:
```
git clone --recursive https://github.com/threefoldfoundation/www_threefold_io.git
```
Now run `build.sh` to download Tailwind, build the CSS, and also build the site with Zola:
```
cd www_threefold_io
bash build.sh
```
Finally, start a browsable local copy of the site that will respond to changes in the source files like this:
```
zola serve
```
Zola will display a local address such as `http://127.0.0.1:1111` which you can click or copy and paste into your browser to view the site on your own machine.
That's it—have fun!
That's it—have fun!