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

Update readme and remove extra file

Browse Source
This commit is contained in:
Scott Yeager
2023-11-15 21:19:35 -08:00
parent dc630e6a5f
commit 03570d8f40
2 changed files with 37 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@@ -20,20 +20,50 @@ Last Updated: May 2023
![readme](https://user-images.githubusercontent.com/43240801/236867088-56c95abd-510c-4202-b0c5-317cdfb75cb3.png)
It is highly important to follow this procedure to contribute to the website content. <br>
__WARNING__: DO NOT commit straight into __master__ / __development__ branch.
__WARNING__: DO NOT commit straight into the __master__ / __development__ branches.
1. Create an Issue
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.
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 __'development'__ branch.
by creating a new branch from 'Master' you will be provided with the latest copy of the live website content.
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.
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 '**maste**r' (production 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).
## 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.
To do that, the following prerequisites are needed:
* 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!

1
hello.md
View File

@@ -1 +0,0 @@
hello world!