added documentation with .collection

This commit is contained in:
mik-tf 2024-04-03 15:01:17 +00:00
parent e87fc85500
commit 698f4dcdc2
6 changed files with 277 additions and 1 deletions

View File

@ -1 +1,273 @@
- [Introduction](intro/intro_readme.md)
- [Introduction](intro/intro_readme.md)
- [Documentation](documentation/documentation.md)
- [Dashboard](documentation/dashboard/dashboard.md)
- [Wallet Connector](documentation/dashboard/wallet_connector.md)
- [TFGrid](documentation/dashboard/tfgrid/tfgrid.md)
- [Grid Status](documentation/dashboard/tfgrid/grid_status.md)
- [Node Statistics](documentation/dashboard/tfgrid/node_statistics.md)
- [Node Monitoring](documentation/dashboard/tfgrid/node_monitoring.md)
- [Deploy](documentation/dashboard/deploy/deploy.md)
- [Pricing Calculator](documentation/dashboard/deploy/pricing_calculator.md)
- [Node Finder](documentation/dashboard/deploy/node_finder.md)
- [Virtual Machines](documentation/dashboard/solutions/vm_intro.md)
- [Micro and Full VM Differences ](documentation/dashboard/solutions/vm_differences.md)
- [Full Virtual Machine](documentation/dashboard/solutions/fullVm.md)
- [Micro Virtual Machine](documentation/dashboard/solutions/vm.md)
- [Nixos MicroVM](documentation/dashboard/solutions/nixos_micro.md)
- [Add a Domain](documentation/dashboard/solutions/add_domain.md)
- [Orchestrators](documentation/dashboard/deploy/orchestrators.md)
- [Kubernetes](documentation/dashboard/solutions/k8s.md)
- [Caprover](documentation/dashboard/solutions/caprover.md)
- [Caprover Admin](documentation/dashboard/solutions/caprover_admin.md)
- [Caprover Worker](documentation/dashboard/solutions/caprover_worker.md)
- [Dedicated Machines](documentation/dashboard/deploy/dedicated_machines.md)
- [Applications](documentation/dashboard/deploy/applications.md)
- [Algorand](documentation/dashboard/solutions/algorand.md)
- [CasperLabs](documentation/dashboard/solutions/casper.md)
- [Discourse](documentation/dashboard/solutions/discourse.md)
- [Funkwhale](documentation/dashboard/solutions/funkwhale.md)
- [Mattermost](documentation/dashboard/solutions/mattermost.md)
- [Nextcloud](documentation/dashboard/solutions/nextcloud.md)
- [Node Pilot](documentation/dashboard/solutions/nodepilot.md)
- [ownCloud](documentation/dashboard/solutions/owncloud.md)
- [Peertube](documentation/dashboard/solutions/peertube.md)
- [Presearch](documentation/dashboard/solutions/presearch.md)
- [Subsquid](documentation/dashboard/solutions/subsquid.md)
- [Taiga](documentation/dashboard/solutions/taiga.md)
- [Umbrel](documentation/dashboard/solutions/umbrel.md)
- [WordPress](documentation/dashboard/solutions/wordpress.md)
- [Your Contracts](documentation/dashboard/deploy/your_contracts.md)
- [Images](documentation/dashboard/deploy/images.md)
- [SSH Keys](documentation/dashboard/deploy/ssh_keys.md)
- [Farms](documentation/dashboard/farms/farms.md)
- [Your Farms](documentation/dashboard/farms/your_farms.md)
- [Farm Finder](documentation/dashboard/farms/farms_finder.md)
- [Node Installer](documentation/dashboard/farms/node_installer.md)
- [Simulator](documentation/dashboard/farms/simulator.md)
- [TFChain](documentation/dashboard/tfchain/tfchain.md)
- [Your Profile](documentation/dashboard/tfchain/your_profile.md)
- [TF DAO](documentation/dashboard/tfchain/tf_dao.md)
- [TF Token Bridge](documentation/dashboard/tfchain/tf_token_bridge.md)
- [TF Token Transfer](documentation/dashboard/tfchain/tf_token_transfer.md)
- [TF Minting Reports](documentation/dashboard/tfchain/tf_minting_reports.md)
- [Developers](documentation/developers/developers.md)
- [Javascript Client](documentation/developers/javascript/grid3_javascript_readme.md)
- [Installation](documentation/developers/javascript/grid3_javascript_installation.md)
- [Loading Client](documentation/developers/javascript/grid3_javascript_loadclient.md)
- [Deploy a VM](documentation/developers/javascript/grid3_javascript_vm.md)
- [Capacity Planning](documentation/developers/javascript/grid3_javascript_capacity_planning.md)
- [Deploy Multiple VMs](documentation/developers/javascript/grid3_javascript_vms.md)
- [Deploy CapRover](documentation/developers/javascript/grid3_javascript_caprover.md)
- [Gateways](documentation/developers/javascript/grid3_javascript_vm_gateways.md)
- [Deploy a Kubernetes Cluster](documentation/developers/javascript/grid3_javascript_kubernetes.md)
- [Deploy a ZDB](documentation/developers/javascript/grid3_javascript_zdb.md)
- [Deploy ZDBs for QSFS](documentation/developers/javascript/grid3_javascript_qsfs_zdbs.md)
- [QSFS](documentation/developers/javascript/grid3_javascript_qsfs.md)
- [Key Value Store](documentation/developers/javascript/grid3_javascript_kvstore.md)
- [VM with Wireguard and Gateway](documentation/developers/javascript/grid3_wireguard_gateway.md)
- [GPU Support](documentation/developers/javascript/grid3_javascript_gpu_support.md)
- [Go Client](documentation/developers/go/grid3_go_readme.md)
- [Installation](documentation/developers/go/grid3_go_installation.md)
- [Loading Client](documentation/developers/go/grid3_go_load_client.md)
- [Deploy a VM](documentation/developers/go/grid3_go_vm.md)
- [Deploy Multiple VMs](documentation/developers/go/grid3_go_vms.md)
- [Deploy Gateways](documentation/developers/go/grid3_go_gateways.md)
- [Deploy Kubernetes](documentation/developers/go/grid3_go_kubernetes.md)
- [Deploy a QSFS](documentation/developers/go/grid3_go_qsfs.md)
- [GPU and Go](documentation/developers/go/grid3_go_gpu.md)
- [GPU Support](documentation/developers/go/grid3_go_gpu_support.md)
- [Deploy a VM with GPU](documentation/developers/go/grid3_go_vm_with_gpu.md)
- [TFCMD](documentation/developers/tfcmd/tfcmd.md)
- [Getting Started](documentation/developers/tfcmd/tfcmd_basics.md)
- [Deploy a VM](documentation/developers/tfcmd/tfcmd_vm.md)
- [Deploy Kubernetes](documentation/developers/tfcmd/tfcmd_kubernetes.md)
- [Deploy ZDB](documentation/developers/tfcmd/tfcmd_zdbs.md)
- [Gateway FQDN](documentation/developers/tfcmd/tfcmd_gateway_fqdn.md)
- [Gateway Name](documentation/developers/tfcmd/tfcmd_gateway_name.md)
- [Contracts](documentation/developers/tfcmd/tfcmd_contracts.md)
- [TFROBOT](documentation/developers/tfrobot/tfrobot.md)
- [Installation](documentation/developers/tfrobot/tfrobot_installation.md)
- [Configuration File](documentation/developers/tfrobot/tfrobot_config.md)
- [Deployment](documentation/developers/tfrobot/tfrobot_deploy.md)
- [Commands and Flags](documentation/developers/tfrobot/tfrobot_commands_flags.md)
- [Supported Configurations](documentation/developers/tfrobot/tfrobot_configurations.md)
- [ThreeFold Chain](documentation/developers/tfchain/tfchain.md)
- [Introduction](documentation/developers/tfchain/introduction.md)
- [Farming Policies](documentation/developers/tfchain/farming_policies.md)
- [External Service Contract](documentation/developers/tfchain/tfchain_external_service_contract.md)
- [Solution Provider](documentation/developers/tfchain/tfchain_solution_provider.md)
- [Grid Proxy](documentation/developers/proxy/proxy_readme.md)
- [Introducing Grid Proxy](documentation/developers/proxy/proxy.md)
- [Setup](documentation/developers/proxy/setup.md)
- [DB Testing](documentation/developers/proxy/db_testing.md)
- [Commands](documentation/developers/proxy/commands.md)
- [Contributions](documentation/developers/proxy/contributions.md)
- [Explorer](documentation/developers/proxy/explorer.md)
- [Database](documentation/developers/proxy/database.md)
- [Production](documentation/developers/proxy/production.md)
- [Release](documentation/developers/proxy/release.md)
- [Flist](documentation/developers/flist/flist.md)
- [Zero-OS Hub](documentation/developers/flist/flist_hub/zos_hub.md)
- [Generate an API Token](documentation/developers/flist/flist_hub/api_token.md)
- [Convert Docker Image Into Flist](documentation/developers/flist/flist_hub/convert_docker_image.md)
- [Supported Flists](documentation/developers/flist/grid3_supported_flists.md)
- [Flist Case Studies](documentation/developers/flist/flist_case_studies/flist_case_studies.md)
- [Case Study: Debian 12](documentation/developers/flist/flist_case_studies/flist_debian_case_study.md)
- [Case Study: Nextcloud AIO](documentation/developers/flist/flist_case_studies/flist_nextcloud_case_study.md)
- [Internals](documentation/developers/internals/internals.md)
- [Reliable Message Bus (RMB)](documentation/developers/internals/rmb/rmb_toc.md)
- [Introduction to RMB](documentation/developers/internals/rmb/rmb_intro.md)
- [RMB Specs](documentation/developers/internals/rmb/rmb_specs.md)
- [RMB Peer](documentation/developers/internals/rmb/uml/peer.md)
- [RMB Relay](documentation/developers/internals/rmb/uml/relay.md)
- [Zero-OS](documentation/developers/internals/zos/readme.md)
- [Manual](documentation/developers/internals/zos/manual/manual.md)
- [Workload Types](documentation/developers/internals/zos/manual/workload_types.md)
- [Internal Modules](documentation/developers/internals/zos/internals/internals.md)
- [Identity](documentation/developers/internals/zos/internals/identity/readme.md)
- [Node ID Generation](documentation/developers/internals/zos/internals/identity/identity.md)
- [Node Upgrade](documentation/developers/internals/zos/internals/identity/upgrade.md)
- [Node](documentation/developers/internals/zos/internals/node/readme.md)
- [Storage](documentation/developers/internals/zos/internals/storage/readme.md)
- [Network](documentation/developers/internals/zos/internals/network/readme.md)
- [Introduction](documentation/developers/internals/zos/internals/network/introduction.md)
- [Definitions](documentation/developers/internals/zos/internals/network/definitions.md)
- [Mesh](documentation/developers/internals/zos/internals/network/mesh.md)
- [Setup](documentation/developers/internals/zos/internals/network/setup_farm_network.md)
- [Flist](documentation/developers/internals/zos/internals/flist/readme.md)
- [Container](documentation/developers/internals/zos/internals/container/readme.md)
- [VM](documentation/developers/internals/zos/internals/vmd/readme.md)
- [Provision](documentation/developers/internals/zos/internals/provision/readme.md)
- [Capacity](documentation/developers/internals/zos/internals/capacity.md)
- [Performance Monitor Package](documentation/developers/internals/zos/performance/performance.md)
- [Public IPs Validation Task](documentation/developers/internals/zos/performance/publicips.md)
- [CPUBenchmark](documentation/developers/internals/zos/performance/cpubench.md)
- [IPerf](documentation/developers/internals/zos/performance/iperf.md)
- [Health Check](documentation/developers/internals/zos/performance/healthcheck.md)
- [API](documentation/developers/internals/zos/manual/api.md)
- [Grid Deployment](documentation/developers/grid_deployment/grid_deployment.md)
- [TFGrid Stacks](documentation/developers/grid_deployment/tfgrid_stacks.md)
- [Full VM Grid Deployment](documentation/developers/grid_deployment/grid_deployment_full_vm.md)
- [Grid Snapshots](documentation/developers/grid_deployment/snapshots.md)
- [Farmers](documentation/farmers/farmers.md)
- [Build a 3Node](documentation/farmers/3node_building/3node_building.md)
- [1. Create a Farm](documentation/farmers/3node_building/1_create_farm.md)
- [2. Create a Zero-OS Bootstrap Image](documentation/farmers/3node_building/2_bootstrap_image.md)
- [3. Set the Hardware](documentation/farmers/3node_building/3_set_hardware.md)
- [4. Wipe All the Disks](documentation/farmers/3node_building/4_wipe_all_disks.md)
- [5. Set the BIOS/UEFI](documentation/farmers/3node_building/5_set_bios_uefi.md)
- [6. Boot the 3Node](documentation/farmers/3node_building/6_boot_3node.md)
- [Farming Optimization](documentation/farmers/farming_optimization/farming_optimization.md)
- [GPU Farming](documentation/farmers/3node_building/gpu_farming.md)
- [Set Additional Fees](documentation/farmers/farming_optimization/set_additional_fees.md)
- [Minting Receipts](documentation/farmers/3node_building/minting_receipts.md)
- [Minting Periods](documentation/farmers/farming_optimization/minting_periods.md)
- [Room Parameters](documentation/farmers/farming_optimization/farm_room_parameters.md)
- [Farming Costs](documentation/farmers/farming_optimization/farming_costs.md)
- [Calculate Your ROI](documentation/farmers/farming_optimization/calculate_roi.md)
- [Advanced Networking](documentation/farmers/advanced_networking/advanced_networking_toc.md)
- [Networking Overview](documentation/farmers/advanced_networking/networking_overview.md)
- [Network Considerations](documentation/farmers/advanced_networking/network_considerations.md)
- [Network Setup](documentation/farmers/advanced_networking/network_setup.md)
- [Farmerbot](documentation/farmers/farmerbot/farmerbot_intro.md)
- [Quick Guide](documentation/farmers/farmerbot/farmerbot_quick.md)
- [Additional Information](documentation/farmers/farmerbot/farmerbot_information.md)
- [Minting and the Farmerbot](documentation/farmers/farmerbot/farmerbot_minting.md)
- [System Administrators](documentation/system_administrators/system_administrators.md)
- [Getting Started](documentation/system_administrators/getstarted/tfgrid3_getstarted.md)
- [SSH Remote Connection](documentation/system_administrators/getstarted/ssh_guide/ssh_guide.md)
- [SSH with OpenSSH](documentation/system_administrators/getstarted/ssh_guide/ssh_openssh.md)
- [SSH with PuTTY](documentation/system_administrators/getstarted/ssh_guide/ssh_putty.md)
- [SSH with WSL](documentation/system_administrators/getstarted/ssh_guide/ssh_wsl.md)
- [WireGuard Access](documentation/system_administrators/getstarted/ssh_guide/ssh_wireguard.md)
- [Remote Desktop and GUI](documentation/system_administrators/getstarted/remote-desktop_gui/remote-desktop_gui.md)
- [Cockpit: a Web-based Interface for Servers](documentation/system_administrators/getstarted/remote-desktop_gui/cockpit_guide/cockpit_guide.md)
- [XRDP: an Open-Source Remote Desktop Protocol](documentation/system_administrators/getstarted/remote-desktop_gui/xrdp_guide/xrdp_guide.md)
- [Apache Guacamole: a Clientless Remote Desktop Gateway](documentation/system_administrators/getstarted/remote-desktop_gui/guacamole_guide/guacamole_guide.md)
- [Planetary Network](documentation/system_administrators/getstarted/planetarynetwork.md)
- [TFGrid Services](documentation/system_administrators/getstarted/tfgrid_services/tf_grid_services_readme.md)
- [GPU](documentation/system_administrators/gpu/gpu_toc.md)
- [GPU Support](documentation/system_administrators/gpu/gpu.md)
- [Terraform](documentation/system_administrators/terraform/terraform_toc.md)
- [Overview](documentation/system_administrators/terraform/terraform_readme.md)
- [Installing Terraform](documentation/system_administrators/terraform/terraform_install.md)
- [Terraform Basics](documentation/system_administrators/terraform/terraform_basics.md)
- [Full VM Deployment](documentation/system_administrators/terraform/terraform_full_vm.md)
- [GPU Support](documentation/system_administrators/terraform/terraform_gpu_support.md)
- [Resources](documentation/system_administrators/terraform/resources/terraform_resources_readme.md)
- [Using Scheduler](documentation/system_administrators/terraform/resources/terraform_scheduler.md)
- [Virtual Machine](documentation/system_administrators/terraform/resources/terraform_vm.md)
- [Web Gateway](documentation/system_administrators/terraform/resources/terraform_vm_gateway.md)
- [Kubernetes Cluster](documentation/system_administrators/terraform/resources/terraform_k8s.md)
- [ZDB](documentation/system_administrators/terraform/resources/terraform_zdb.md)
- [Quantum Safe Filesystem](documentation/system_administrators/terraform/resources/terraform_qsfs.md)
- [QSFS on Micro VM](documentation/system_administrators/terraform/resources/terraform_qsfs_on_microvm.md)
- [QSFS on Full VM](documentation/system_administrators/terraform/resources/terraform_qsfs_on_full_vm.md)
- [CapRover](documentation/system_administrators/terraform/resources/terraform_caprover.md)
- [Advanced](documentation/system_administrators/terraform/advanced/terraform_advanced_readme.md)
- [Terraform Provider](documentation/system_administrators/terraform/advanced/terraform_provider.md)
- [Terraform Provisioners](documentation/system_administrators/terraform/advanced/terraform_provisioners.md)
- [Mounts](documentation/system_administrators/terraform/advanced/terraform_mounts.md)
- [Capacity Planning](documentation/system_administrators/terraform/advanced/terraform_capacity_planning.md)
- [Updates](documentation/system_administrators/terraform/advanced/terraform_updates.md)
- [SSH Connection with Wireguard](documentation/system_administrators/terraform/advanced/terraform_wireguard_ssh.md)
- [Set a Wireguard VPN](documentation/system_administrators/terraform/advanced/terraform_wireguard_vpn.md)
- [Synced MariaDB Databases](documentation/system_administrators/terraform/advanced/terraform_mariadb_synced_databases.md)
- [Nomad](documentation/system_administrators/terraform/advanced/terraform_nomad.md)
- [Nextcloud Deployments](documentation/system_administrators/terraform/advanced/terraform_nextcloud_toc.md)
- [Nextcloud All-in-One Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_aio.md)
- [Nextcloud Single Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_single.md)
- [Nextcloud Redundant Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_redundant.md)
- [Nextcloud 2-Node VPN Deployment](documentation/system_administrators/terraform/advanced/terraform_nextcloud_vpn.md)
- [Pulumi](documentation/system_administrators/pulumi/pulumi_readme.md)
- [Introduction to Pulumi](documentation/system_administrators/pulumi/pulumi_intro.md)
- [Installing Pulumi](documentation/system_administrators/pulumi/pulumi_install.md)
- [Deployment Examples](documentation/system_administrators/pulumi/pulumi_examples.md)
- [Deployment Details](documentation/system_administrators/pulumi/pulumi_deployment_details.md)
- [Mycelium](documentation/system_administrators/mycelium/mycelium_toc.md)
- [Overview](documentation/system_administrators/mycelium/overview.md)
- [Installation](documentation/system_administrators/mycelium/installation.md)
- [Additional Information](documentation/system_administrators/mycelium/information.md)
- [Message](documentation/system_administrators/mycelium/message.md)
- [Packet](documentation/system_administrators/mycelium/packet.md)
- [Data Packet](documentation/system_administrators/mycelium/data_packet.md)
- [API YAML](documentation/system_administrators/mycelium/api_yaml.md)
- [Computer and IT Basics](documentation/system_administrators/computer_it_basics/computer_it_basics.md)
- [CLI and Scripts Basics](documentation/system_administrators/computer_it_basics/cli_scripts_basics.md)
- [Docker Basics](documentation/system_administrators/computer_it_basics/docker_basics.md)
- [Git and GitHub Basics](documentation/system_administrators/computer_it_basics/git_github_basics.md)
- [Firewall Basics](documentation/system_administrators/computer_it_basics/firewall_basics/firewall_basics.md)
- [UFW Basics](documentation/system_administrators/computer_it_basics/firewall_basics/ufw_basics.md)
- [Firewalld Basics](documentation/system_administrators/computer_it_basics/firewall_basics/firewalld_basics.md)
- [File Transfer](documentation/system_administrators/computer_it_basics/file_transfer.md)
- [Advanced](documentation/system_administrators/advanced/advanced.md)
- [Token Transfer Keygenerator](documentation/system_administrators/advanced/token_transfer_keygenerator.md)
- [Cancel Contracts](documentation/system_administrators/advanced/cancel_contracts.md)
- [Contract Bills Reports](documentation/system_administrators/advanced/contract_bill_report.md)
- [Listing Free Public IPs](documentation/system_administrators/advanced/list_public_ips.md)
- [Redis](documentation/system_administrators/advanced/grid3_redis.md)
- [IPFS](documentation/system_administrators/advanced/ipfs/ipfs_toc.md)
- [IPFS on a Full VM](documentation/system_administrators/advanced/ipfs/ipfs_fullvm.md)
- [IPFS on a Micro VM](documentation/system_administrators/advanced/ipfs/ipfs_microvm.md)
- [ThreeFold Token](documentation/threefold_token/threefold_token.md)
- [TFT Bridges](documentation/threefold_token/tft_bridges/tft_bridges.md)
- [TFChain-Stellar Bridge](documentation/threefold_token/tft_bridges/tfchain_stellar_bridge.md)
- [BSC-Stellar Bridge](documentation/threefold_token/tft_bridges/bsc_stellar_bridge.md)
- [BSC-Stellar Bridge Verification](documentation/threefold_token/tft_bridges/bsc_stellar_bridge_verification.md)
- [Ethereum-Stellar Bridge](documentation/threefold_token/tft_bridges/tft_ethereum/tft_ethereum.md)
- [Storing TFT](documentation/threefold_token/storing_tft/storing_tft.md)
- [ThreeFold Connect App (Stellar)](documentation/threefold_token/storing_tft/tf_connect_app.md)
- [Lobstr Wallet (Stellar)](documentation/threefold_token/storing_tft/lobstr_wallet.md)
- [MetaMask (BSC & ETH)](documentation/threefold_token/storing_tft/metamask.md)
- [Hardware Wallet](documentation/threefold_token/storing_tft/hardware_wallet.md)
- [Buy and Sell TFT](documentation/threefold_token/buy_sell_tft/buy_sell_tft.md)
- [Quick Start (Stellar)](documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_short_guide.md)
- [Lobstr Wallet (Stellar)](documentation/threefold_token/buy_sell_tft/tft_lobstr/tft_lobstr_complete_guide.md)
- [MetaMask (BSC & ETH)](documentation/threefold_token/buy_sell_tft/tft_metamask/tft_metamask.md)
- [Pancake Swap (BSC)](documentation/threefold_token/buy_sell_tft/pancakeswap.md)
- [Liquidity Provider (LP)](documentation/threefold_token/liquidity/liquidity_readme.md)
- [Pancake Swap LP](documentation/threefold_token/liquidity/liquidity_pancake.md)
- [1inch.io LP](documentation/threefold_token/liquidity/liquidity_1inch.md)
- [Albedo LP](documentation/threefold_token/liquidity/liquidity_albedo.md)
- [Transaction Fees](documentation/threefold_token/transaction_fees.md)
- [FAQ](documentation/faq/faq.md)

View File

View File

View File

@ -0,0 +1 @@
intro_header.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 849 KiB

After

Width:  |  Height:  |  Size: 460 KiB

View File

@ -8,5 +8,8 @@
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/intro'
!!doctree.add
url:'https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/collections/documentation'
```