tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity
mdbook
811 Commits 5 Branches 0 Tags 757 MiB
HTML 58.9%
Shell 27%
Mermaid 10.9%
V 2.6%
Makefile 0.6%
066169ad5f
Go to file
mik-tf 066169ad5f Merge pull request 'dev_docs' (!150) from dev_docs into development 
Reviewed-on: #150
2024-10-23 03:36:34 +00:00
_archive fix includes syntax 2024-10-04 08:02:33 +02:00
books ... 2024-10-14 09:27:55 +04:00
collections ... 2024-10-14 09:27:55 +04:00
collections_beta tfgrid4 economy update 2024-05-08 14:10:20 -04:00
docs updated with advice 2024-10-22 23:35:59 -04:00
heroscript Delete heroscript/legal/sshkey.md 2024-10-16 15:42:27 +00:00
heroweb ... 2024-09-18 07:40:11 +03:00
scripts Update scripts/hero_mdbook.sh 2024-02-22 15:04:48 +00:00
specs ... 2024-03-18 14:28:08 +02:00
.gitignore ... 2024-09-19 06:32:47 +04:00
CODEOWNERS added codeowners 2024-05-16 14:24:55 -04:00
hero_mdbook.sh stated tft for grants 2024-04-25 14:19:14 -04:00
LICENSE ... 2024-01-26 06:06:57 +03:00
README.md readme update contribute 2024-05-16 13:47:24 -04:00
sshkey.md ... 2024-02-05 12:51:02 +03:00
sync_production.sh .. 2024-03-19 08:28:25 +02:00

README.md

TFGrid Docs

Table of Contents

Overview

This repository contains TFGrid docs in the form of mdbooks generated with the Hero tool.

To see the whole list of books, check the heroscript directory.

Basic Hero mdBook Commands

Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser:

  • Pull new changes

    hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp

  • Build the book

    hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook

  • Preview on a web browser

    hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -o

Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the docs.

Install and Use Hero

install hero as follows

curl https://raw.githubusercontent.com/freeflowuniverse/crystallib/development/scripts/installer_hero.sh | bash /tmp/hero_install.sh

you can also do it on a VM (experts only)

To install and use Hero on a full VM running on the grid, read the full VM guide.

Create a New mdBook

To create a new mdbook, read the mdbook creation guide.

Use Hero with Docker

You can use Hero with Docker. Read the docs here.

Contribute

To optimize updates to this repository, we propose a uniform way to collaborate.

Branches and Forks

To contribute to this repository, make a pull request of your changes. There are two main methods.

  1. Fork the repository and make a pull requests with your changes
  2. If you have access, create a new branch in this repo and make a pull request with your changes

Overview

  • The production-ready content is published on the main branch
  • The staging content is published on the development branch
  • Any changes to development must go through a pull request (PR) and its associated review from a different branch with the prefix development_.
    • The name of the branch should indicate the work being done, e.g. working on the readme, development_readme_work
  • Once staging is done on development, the code owners will merge development branch to main branch.
    • The mdbooks will be updated online.

Content Update Procedure

  • Create new branch out of development (e.g. development_work)
  • Make changes to the files
  • Make a PR to merge to development
    • Get reviewed and adjust accordingly
  • PR is approved and the content is merged to development
  • Code owners will merge development to main to update the books online