This commit is contained in:
kristof de spiegeleer 2024-04-21 12:19:04 +02:00
parent 9aa51c39d6
commit 9c7a933b28
5 changed files with 103 additions and 2 deletions

View File

@ -1,2 +1,47 @@
# info_veda
<h1> TFGrid Docs</h1>
<h2>Table of Contents</h2>
- [Overview](#overview)
- [Basic Hero mdBook Commands](#basic-hero-mdbook-commands)
- [Install and Use Hero](#install-and-use-hero)
- [Create a New mdBook](#create-a-new-mdbook)
- [Notes for Repo Owners](#notes-for-repo-owners)
## Overview
This repository contains TFGrid docs in the form of mdbooks generated with the [Hero](https://github.com/freeflowuniverse/crystallib/tree/development/cli/hero) tool.
To see the whole list of books, check the [heroscript directory](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript).
## 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](https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/docs).
## Install and Use Hero
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).
## Create a New mdBook
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).
## Notes for Repo Owners
> todo: kristof some content does not belong here, move to other repo

View File

@ -0,0 +1,27 @@
```js
!!book.generate name:'hero' title:'Hero'
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/books/hero'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/hero'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/tech'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/p2p'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/def'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/why'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/social_media_protocols'
```

View File

@ -0,0 +1,11 @@
```js
!!books.configure
buildroot:'~/hero/var/mdbuild'
publishroot:'~/hero/www/info'
install:true
reset:false
```

14
heroscript/hero/sshkey.md Normal file
View File

@ -0,0 +1,14 @@
```js
!!sshagent.key_add
name:'books'
privkey:'
-----BEGIN OPENSSH PRIVATE KEY-----
b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtzc2gtZW
QyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQAAAIhb3ybRW98m
0QAAAAtzc2gtZWQyNTUxOQAAACDXf9Z/2AH8/8a1ppagCplQdhWyQ8wZAieUw3nNcxsDiQ
AAAEC+fcDBPqdJHlJOQJ2zXhU2FztKAIl3TmWkaGCPnyts49d/1n/YAfz/xrWmlqAKmVB2
FbJDzBkCJ5TDec1zGwOJAAAABWJvb2tz
-----END OPENSSH PRIVATE KEY-----
'
```

4
sync_production.sh Executable file
View File

@ -0,0 +1,4 @@
#!/bin/bash
# /bin/bash ~/hero/var/mdbuild/duniayetu/build.sh
rsync -rv ~/hero/www/info/duniayetu/ root@info.ourworld.tf:/root/hero/www/info/tfgrid4/
rsync -rv ~/hero/www/info/duniayetu/ root@info.ourworld.tf:/root/hero/www/info/tfgrid4/