ourworld_web/www_threefold_io
23
0
Fork 0
Code Issues 1 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

18
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,18 @@
![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 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).