test links manual_org

threefoldtech · Feb 19, 2024 · 8db70e2 · 8db70e2
2 parents 6203630 + a78ab65
commit 8db70e2
Show file tree

Hide file tree

Showing 239 changed files with 3,440 additions and 1,545 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,5 @@ book/
 .DS_Store
 src/threefold_token/token_overview/special_wallets/wallet_data/
 src/threefold_token/token_overview/special_wallets/wallet_data/*
+src/values/
+src/values/*
diff --git a/book.toml b/book.toml
@@ -1,5 +1,5 @@
 [book]
-title = "ThreeFold Knowledge Base"
+title = "ThreeFold Grid Manual"
 
 [output.html.fold]
 enable = true

diff --git a/src/SUMMARY.md b/src/SUMMARY.md
diff --git a/src/TF_Grid_Services/tf_grid_services_readme.md b/src/TF_Grid_Services/tf_grid_services_readme.md
@@ -1,4 +1,17 @@
-# ThreeFold Grid Services
+<h1> ThreeFold Grid Services </h1>
+
+<h2> Table of Contents </h2>
+
+- [Introduction](#introduction)
+- [Devnet](#devnet)
+- [QAnet](#qanet)
+- [Testnet](#testnet)
+- [Mainnet](#mainnet)
+  - [Supported Planetary Network Nodes](#supported-planetary-network-nodes)
+
+***
+
+## Introduction
 
 On this article we have aggregated a list of all of the services running on Threefold Grid 3 infrastructure for your convenience
 

diff --git a/src/advanced/advanced.md b/src/advanced/advanced.md
@@ -2,8 +2,6 @@
 
 In this section, we delve into sophisticated topics and powerful functionalities that empower you to harness the full potential of TFGrid 3.0. Whether you're an experienced user seeking to deepen your understanding or a trailblazer venturing into uncharted territories, this manual is your gateway to mastering advanced concepts on the ThreeFold Grid.
 
-![](img/advanced_.png)
-
 <h2>Table of Contents</h2>
 
 - [Grid3 Stellar-TFChain Bridge](./grid3_stellar_tfchain_bridge.md)

diff --git a/src/advanced/grid3_redis.md b/src/advanced/grid3_redis.md
@@ -16,7 +16,7 @@ Redis is an open-source, in-memory data structure store that is widely used as a
 
 Redis is widely used in various use cases, including caching, session management, real-time analytics, leaderboards, task queues, and more. Its simplicity, speed, and flexibility make it a popular choice for developers who need a fast and reliable data store for their applications. In Threefold's ecosystem context, Redis can be used as a backend mechanism to communicate with the nodes on the ThreeFold Grid using the Reliable Message Bus.
 
-***
+
 
 ## Install Redis
 
@@ -35,7 +35,7 @@ brew install redis
 
 Alternatively, it can be built from source, using the same [download page](https://redis.io/download/) as shown above.
 
-***
+
 
 ## Run Redis
 

diff --git a/src/advanced/ipfs/ipfs_fullvm.md b/src/advanced/ipfs/ipfs_fullvm.md
@@ -1,7 +1,5 @@
 <h1> IPFS on a Full VM</h1>
 
-![ipfs_logo](../img/ipfs_logo.png)
-
 <h2>Table of Contents</h2>
 
 - [Introduction](#introduction)

diff --git a/src/advanced/ipfs/ipfs_microvm.md b/src/advanced/ipfs/ipfs_microvm.md
@@ -1,7 +1,5 @@
 <h1> IPFS on a Micro VM</h1>
 
-![ipfs_logo](../img/ipfs_logo.png)
-
 <h2>Table of Contents</h2>
 
 - [Introduction](#introduction)

diff --git a/src/advanced/ipfs/ipfs_toc.md b/src/advanced/ipfs/ipfs_toc.md
@@ -1,7 +1,5 @@
 <h1>IPFS and ThreeFold</h1>
 
-![ipfs_log](../img/ipfs_logo.png)
-
 <h2>Table of Contents</h2>
 
 - [IPFS on a Full VM](./ipfs_fullvm.md)

diff --git a/src/advanced/list_public_ips.md b/src/advanced/list_public_ips.md
@@ -1,7 +1,18 @@
-# Listing Public IPs
+<h1> Listing Public IPs </h1>
+
+<h2>Table of Contents </h2>
+
+- [Introduction](#introduction)
+- [Example](#example)
+
+***
+
+## Introduction
 
 Listing public IPs can be done by asking graphQL for all IPs that has `contractId = 0`
 
+## Example
+
 ```graphql
 query MyQuery {
   publicIps(where: {contractId_eq: 0}) {

diff --git a/src/collaboration_tools/circle_tool.md b/src/collaboration_tools/circle_tool.md
@@ -1,8 +1,9 @@
-<h1> ThreeFold's Circle Tool </h1>
+<h1> ThreeFold Circle Tool </h1>
 
 <h2>Table of Contents</h2>
 
 - [Introduction](#introduction)
+- [Overview](#overview)
 - [Prerequisites](#prerequisites)
 - [How to Use the Circle Tool](#how-to-use-the-circle-tool)
 - [Circle Tool Overview](#circle-tool-overview)
@@ -16,21 +17,25 @@
 
 ***
 
-# Introduction
+## Introduction
 
-![ ](./img/taiga.png)
-
-[__ThreeFold's Circle Tool__](https://circles.threefold.me ) is our own self-hosted (desktop only) project management tool based on [Taiga](https://www.taiga.io/), an open-source project management tool for cross-functional agile. It offers a lot of different project management kits and features such as the scrum board, kanban board, issues management, and many more. 
+The [__ThreeFold Circle Tool__](https://circles.threefold.me ) is our own self-hosted (desktop only) project management tool based on [Taiga](https://www.taiga.io/), an open-source project management tool for cross-functional agile. It offers a lot of different project management kits and features such as the scrum board, kanban board, issues management, and many more. 
 
 Our teams at ThreeFold use the Circle Tool to self-manage our tasks, thus it is deemed necessary for the new onboarded team members to learn how to use the tool. Unfortunately we only provide the desktop version of the tool at this moment since we normally manage our projects on the computer.
 
 This manual will be a beneficial thing to read for anyone: our team members, as well as our community members who are interested in using Circle Tool for their projects.
 
-# Prerequisites
+## Overview
+
+Here is an overview of the tool.
+
+![ ](./img/taiga.png)
+
+## Prerequisites
 
 You would need to install and create an account on the [TF Connect App](../getstarted/TF_Connect/TF_Connect.md) before being able to register and use the Circle Tool.
 
-# How to Use the Circle Tool
+## How to Use the Circle Tool
 
 * Go to [Circle Tool's desktop homepage](https://circles.threefold.me) on your computer as shown below. Click on '__Login__' button on the very top right corner of your screen.
 
@@ -58,51 +63,51 @@ You would need to install and create an account on the [TF Connect App](../getst
 
 ***
 
-# Circle Tool Overview
+## Circle Tool Overview
 
 The Circle Tool always try to make things easy and intuitive for new users but it’s good to have a nice & quick overview for your first couple of days.
 
-# Dashboard View
+## Dashboard View
 
 ![ ](./img/dashboard.png)
 
 Upon login or if you just go to your Circle Tool, you’re confronted with your dashboard with quick access to your working on items, a list of watched items and shortcuts to your projects. You can always go back to your dashboard by clicking on the Taiga 
 icon on the top bar.
 
-# Profile view
+## Profile view
 
 ![ ](./img/profile.png)
 
 Circle Tool has an additional section to get a multiproject view where you can find and list everything that is accessible to you. Simply click on your avatar and you access your personal profile section where you can check from what your personal bio looks like for people that might have access to it to all sorts of information on your activities and relevant content.
 
-# Projects
+## Projects
 
 ![ ](./img/project.png)
 
 You can access your assigned projects by clicking on Projects link at the top left of your screen. You can hover and get an interactive shortlist or click on the link and go to a dedicated page where you can access them as well as rearrange them. Once you have clicked on a project, you access your default view for that project, which is always the Project’s Timeline if you haven’t changed that.
 
 
-# Scrum Module on Project
+## Scrum Module on Project
 
 ![ ](./img/homeproject.png)
 
 Every circle project can activate the Scrum module. This also happens automatically if you chose the Scrum template upon project creation. You can find the scrum module on the sidebar of your project page. 
 
 Scrum is an agile framework for developing, delivering, and sustaining complex products. Although it had an initial emphasis on software development, it has been used in other fields including research, sales, marketing and advanced technologies. 
 
-## Scrum Backlog
+### Scrum Backlog
 
 ![ ](./img/backlog.png)
 
 There are various so called artifacts in Scrum. The top three are the Backlog, the User Stories and the Sprints. They respectively represent what is to be done ordered by priority and readyness, the pieces of work themselves and the fixed time periods in which we put selected User Stories to be worked upon and finished.
 
-## Scrum Sprints
+### Scrum Sprints
 
 ![ ](./img/sprints.png)
 
 The Scrum Backlog view will always show a summary view of ongoing or closed Sprints but teams generally stick to the Sprint Taskboard view when they are focused on getting things done for that Sprint. Click on either the Sprint name or the “Sprint Taskboard” button so you can access the very important Sprint Taskboard. Open Sprints appear as shortcuts through the left navigation pane’s Scrum icon.
 
 
-# More Info
+## More Info
 
 You can read more about the Circle Tool (Taiga), scrum, sprints, and other documentations on Taiga's project management features on Taiga's official documentation [here](https://community.taiga.io/). Happy Project Managing!
diff --git a/src/collaboration_tools/website_tool.md b/src/collaboration_tools/website_tool.md
@@ -1,7 +1,5 @@
 <h1> Zola Website Deployer</h1>
 
-![](./img/websitetool.jpeg)  
-
 <h2> Table of Contents </h2>
 
 - [Overview](#overview)
@@ -33,7 +31,6 @@
 - [Important Links](#important-links-5)
 - [Questions and Feedback](#questions-and-feedback)
 
-
 ***
 
 ## Overview
@@ -47,7 +44,7 @@ At ThreeFold, we utilized Website Tool to deploy all of our web presences. For e
 
 While you can also publish a static website using Zola alone, we at ThreeFold have customized the framework and created a static website template that makes it even easier for anyone to build a website by simply cloning template and fill it with their own website content.
 
-***
+
 
 ## Prerequisites
 
@@ -66,7 +63,7 @@ In order to deploy and publish a website using ThreeFold Website Tool, you would
 > - [Learn Markdown Language](https://www.markdownguide.org/)
 > - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/)
 
-***
+
 
 ## Installing Zola Onto Your Machine
 
@@ -101,7 +98,7 @@ For more details on Zola Installation, and installation guidelines for other ope
 
 > Next Step: [Template Guide: How to use the TF Web Template](#template-guide)
 
-***
+
 
 ## Get Started
 
@@ -172,7 +169,7 @@ And then go to **_index.md** file and replace the **logo_path**: images/yourlogo
 
 > - [TF Web Template](https://github.com/threefoldfoundation/www_examplezola)
 
-***
+
 
 ## Customization
 
@@ -301,7 +298,7 @@ Once your website is online, you can also use the [Website Link Checker](./websi
 
 > - [Command Line Cheat Sheet](https://cs.colby.edu/maxwell/courses/tutorials/terminal/)
 
-***
+
 
 ## Publish Your Website (Via Github Pages)
 
@@ -327,14 +324,14 @@ And you are done! Your website will be published, and it will take only a minute
 
 ![](./img/done.png)
 
-***
+
 
 ## Important Links
 > - [Pushing Changes to Github](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/pushing-changes-to-github)
 > - [Github Pages How-to](https://docs.github.com/en/pages)
 > - [Adding Custom Domain to my Github Page](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
 
-***
+
 
 ## Questions and Feedback