diff --git a/README.md b/README.md index 8daed23..90f0ddf 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,47 @@ -

ThreeFold TFGrid Main Documentation website

+

ThreeFold TFGrid Main Documentation Website

+

Table of Contents

-to run in development mode +- [Introduction](#introduction) +- [Install Hero](#install-hero) +- [Deploy Locally](#deploy-locally) +- [Push Changes](#push-changes) +- [URL](#url) + +--- + +## Introduction + +This repository contains the code to deploy the ThreeFold TFGrid Main Documentation website. + +## Install Hero ```bash -#first time to get hero curl https://raw.githubusercontent.com/freeflowuniverse/herolib/refs/heads/development/install_hero.sh > /tmp/install_hero.sh bash /tmp/install_hero.sh -#DONT FORGET TO START A NEW SHELL (otherwise the paths will not be set) +``` +## Deploy Locally + +You can run the website in your development environment on a local browser. Make sure to start a new shell if you've just installed Hero. + +``` hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_tfgrid4 -d ``` -to push +## Push Changes -```bash -hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_tfgrid4 -bp -update +- Development + ``` + hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_tfgrid4 -bpd + ``` +- Production -#push for development: -hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_tfgrid4 -bpd -update -``` + ```bash + hero docusaurus -u https://git.ourworld.tf/tfgrid/docs_tfgrid4 -bp + ``` ## URL -- The production website is available at `https://docs.threefold.io/` \ No newline at end of file +- The website in staging mode is at https://dev.threefold.info +- The website in production mode is at https://docs.threefold.io \ No newline at end of file diff --git a/cfg/basic.heroscript b/cfg/basic.heroscript index 607c08b..dd822f5 100644 --- a/cfg/basic.heroscript +++ b/cfg/basic.heroscript @@ -1,11 +1,11 @@ -!!docusaurus.publish - cat:'dev' - dest:'root@info.ourworld.tf:/root/hero/www/info/tfgrid4' - !!docusaurus.publish cat:'prod' + dest:'root@info.ourworld.tf:/root/hero/www/info/tfgrid4' + +!!docusaurus.publish + cat:'dev' dest:'root@info.ourworld.tf:/root/hero/www/infodev/tfgrid4' !!docusaurus.import