info_tfgrid/README.md

88 lines
3.5 KiB
Markdown
Raw Normal View History

<h1> TFGrid Docs</h1>
2024-02-05 02:49:16 +00:00
<h2>Table of Contents</h2>
2024-02-05 09:44:04 +00:00
- [Overview](#overview)
2024-04-02 20:51:33 +00:00
- [Basic Hero mdBook Commands](#basic-hero-mdbook-commands)
- [Install and Use Hero](#install-and-use-hero)
2024-04-02 20:51:33 +00:00
- [Create a New mdBook](#create-a-new-mdbook)
- [Use Hero with Docker](#use-hero-with-docker)
2024-04-10 20:20:52 +00:00
- [Contribute](#contribute)
2024-05-16 17:47:24 +00:00
- [Branches and Forks](#branches-and-forks)
- [Overview](#overview-1)
- [Content Update Procedure](#content-update-procedure)
2024-03-22 17:08:46 +00:00
## Overview
2024-03-22 17:08:46 +00:00
This repository contains TFGrid docs in the form of mdbooks generated with the [Hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool.
2024-03-22 17:08:46 +00:00
2024-04-02 21:00:42 +00:00
To see the whole list of books, check the [heroscript directory](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript).
2024-03-22 17:08:46 +00:00
2024-04-02 20:51:33 +00:00
## Basic Hero mdBook Commands
2024-03-22 17:08:46 +00:00
Once Hero is set on your machine, you can run the following commands to preview mdbooks on your local browser:
2024-03-22 17:08:46 +00:00
- Pull new changes
```
hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript/nameofyourbook -gp
```
2024-03-22 17:08:46 +00:00
- 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
```
2024-04-02 21:00:42 +00:00
> Note: You can use -p instead of -u and set a path to your heroscript directory, as explained in the [docs](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs).
## Install and Use Hero
2024-04-16 10:26:11 +00:00
install hero as follows
```bash
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)
2024-04-02 21:00:42 +00:00
To install and use Hero on a full VM running on the grid, read the [full VM guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_fullvm.md).
2024-04-02 20:51:33 +00:00
## Create a New mdBook
2024-04-02 21:00:42 +00:00
To create a new mdbook, read the [mdbook creation guide](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_create_mdbook.md).
## Use Hero with Docker
You can use Hero with Docker. Read the docs [here](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs/hero_mdbook_docker.md).
2024-04-10 20:20:52 +00:00
## Contribute
2024-05-16 17:47:24 +00:00
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.
2024-04-10 20:20:52 +00:00
1. Fork the repository and make a pull requests with your changes
2024-05-16 17:47:24 +00:00
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