diff --git a/README.md b/README.md index 2c37f5d0b..1c9c17929 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,39 @@ -# ThreeFold +# Welcome to ThreeFold Website Repository ![](./static/images/tf_logo.png) ## About -The official website of ThreeFold Foundation +The official website of ThreeFold Foundation.
-[www.threefold.io](https://www.threefold.io) +Production: [www.threefold.io](https://www.threefold.io) (master branch) -## Contribution +Staging: www2.threefold.io (development branch) -Feel free to [create a new issue](https://github.com/threefoldfoundation/www_threefold_io/issues) to report an error on the website, or if you have any suggestions on website improvements. +Last Updated: May 2023 + +## Administrators +[ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) + +## Contribution Procedure + +![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.
+__WARNING__: DO NOT commit straight into __master__ / __development__ branch. + +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. + +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. + +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 '**maste**r' (production branch) + +10. When PR is approved, you can see your changes live on production www.threefold.io (master branch).