info_tfgrid/README.md

TFGrid Docs

Table of Contents

• Overview
• Basic Hero mdBook Commands
• Install and Use Hero
• Create a New mdBook
• Use Hero with Docker
• Contribute

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 contribute to this repository, make a pull request of your changes.

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