From abb1d4f373d9c52a242a7f9082e274455798d705 Mon Sep 17 00:00:00 2001 From: mik-tf Date: Sun, 1 Feb 2026 12:24:47 -0500 Subject: [PATCH 01/11] fix: update broken link to ipxe repository --- .../web_gateway/web_gateway_hetzner.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/labs/docs/documentation/farmers/advanced_networking_toc/web_gateway/web_gateway_hetzner.md b/labs/docs/documentation/farmers/advanced_networking_toc/web_gateway/web_gateway_hetzner.md index 0a9132ab..1f908326 100644 --- a/labs/docs/documentation/farmers/advanced_networking_toc/web_gateway/web_gateway_hetzner.md +++ b/labs/docs/documentation/farmers/advanced_networking_toc/web_gateway/web_gateway_hetzner.md @@ -48,7 +48,7 @@ ssh root@ 1. Clone the ThreeFold IPXE fork: ```bash -git clone https://github.com/threefold/ipxe.git +git clone https://github.com/threefoldtech/ipxe.git ``` 2. Install required package: @@ -118,4 +118,4 @@ net0/gateway Then you can follow the steps in the manual to properly set your public configuration and DNS. - [Set Up the Public Config](../../../dashboard/farms/your_farms) -- [Set Up a Gateway Domain](../gateway_domain.md) \ No newline at end of file +- [Set Up a Gateway Domain](../gateway_domain.md) From 7c32c7f038c22fbf5e5512d26e6104cf7435af48 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 09:23:01 +0200 Subject: [PATCH 02/11] docs: add Apache LICENSE with TFTech NV copyright and update README with license reference --- LICENSE | 18 ++++-------------- README.md | 7 ++++++- 2 files changed, 10 insertions(+), 15 deletions(-) diff --git a/LICENSE b/LICENSE index 3d51c6f9..badbc1d5 100644 --- a/LICENSE +++ b/LICENSE @@ -48,7 +48,7 @@ "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner + submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent @@ -175,18 +175,8 @@ END OF TERMS AND CONDITIONS - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2025 ThreeFold + Copyright (c) TFTech NV + Belgian enterprise number = BE 0712.845.674 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -198,4 +188,4 @@ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file + limitations under the License. diff --git a/README.md b/README.md index ace9132e..01e2a457 100644 --- a/README.md +++ b/README.md @@ -75,4 +75,9 @@ If you want to contribute to [Manual.grid.tf](https://manual.grid.tf/), you shou 1. Add the md file to the appropriate directory in the Docusaurus project structure. 2. Update the sidebar configuration if needed. -3. Use `yarn start` to preview your changes locally. \ No newline at end of file +3. Use `yarn start` to preview your changes locally. + +## License + +This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. +Copyright (c) TFTech NV. \ No newline at end of file From 01422fcfeff54df359c289d84614a75cd66b70b0 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 09:57:24 +0200 Subject: [PATCH 03/11] docs: update README with neutral technical framing and TF-Tech NV ownership --- README.md | 72 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 47 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 01e2a457..2ff4750a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ -# Threefold Grid Manual +# Info Grid -# Website +A Docusaurus-based documentation site containing user guides, technical references, and FAQ content for grid infrastructure. -This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. +## What this is + +Info Grid is the primary documentation platform for the decentralized infrastructure stack. It provides comprehensive instructions for operators, developers, and end users interacting with the grid, including farming guides, deployment tutorials, API references, and troubleshooting documentation. + +The site is built as a static site using Docusaurus and is designed to be the single source of truth for all grid-related documentation. + +## What this repository contains + +- Docusaurus site configuration and theme customization +- Markdown documentation source files organized by topic +- Custom client-side search engine implementation +- Dynamic content generation scripts (pricing data, search index) +- Build and deployment automation via Makefile + +## Role in the stack + +Info Grid sits alongside the operational stack as the user-facing documentation layer. It explains how to use the grid infrastructure, from initial node setup to advanced workload deployment. The documentation is versioned and covers multiple network environments. + +## Relation to ThreeFold + +This technology is used within the ThreeFold ecosystem and was first deployed on the ThreeFold Grid. The component itself is designed as reusable infrastructure technology and should be understood by its technical function first, independent of any specific deployment. + +## Ownership + +This repository is owned and maintained by TF-Tech NV, a Belgian company responsible for the development and maintenance of this technology. ## Browse docs -- The official ThreeFold manual from master branch is available at [www.manual.grid.tf](https://manual.grid.tf/) -- Staging version from development branch is available at [www.manual.dev.grid.tf](https://www.manual.dev.grid.tf) -- Staging version from development-split branch is available at [www3.manual.grid.tf](https://www3.manual.grid.tf) +- Official manual (master branch): [manual.grid.tf](https://manual.grid.tf/) +- Staging (development branch): [www.manual.dev.grid.tf](https://www.manual.dev.grid.tf) +- Staging (development-split branch): [www3.manual.grid.tf](https://www3.manual.grid.tf) ## Development @@ -34,8 +58,6 @@ This starts a local development server with auto-generated content and opens a b ### Build Process -The site uses a multi-stage build process: - ```bash # Generate all dynamic content make prebuild @@ -48,36 +70,36 @@ make serve ``` **Available Make targets:** -- `make prepare-data` - Generate pricing values from external APIs -- `make generate-search` - Create search index from documentation -- `make prebuild` - Run all pre-build data generation -- `make build` - Complete production build -- `make dev` - Development server with live updates -- `make clean` - Clean build artifacts +- `make prepare-data` — generate pricing values from external APIs +- `make generate-search` — create search index from documentation +- `make prebuild` — run all pre-build data generation +- `make build` — complete production build +- `make dev` — development server with live updates +- `make clean` — clean build artifacts ## Architecture -This Docusaurus site includes several custom features: - ### Custom Search Engine -Client-side search implementation providing fast, cost-free search without external dependencies. The search system indexes all documentation at build time and offers instant results with mobile-optimized UI. + +A client-side search implementation provides fast, cost-free search without external dependencies. The search system indexes all documentation at build time and offers instant results with a mobile-optimized UI. ### Dynamic Content Generation -- **Pricing Values**: Auto-updated from external TFT market sources -- **Search Index**: Generated from all markdown content with smart URL handling -- **Responsive Design**: Mobile-first UI with optimized navigation + +- **Pricing Values**: auto-updated from external market sources +- **Search Index**: generated from all Markdown content with smart URL handling +- **Responsive Design**: mobile-first UI with optimized navigation ## Contribute -Be sure to check the [versioning explanation](./versioning.md) first. Make pull request to the appropriate branch. +Be sure to check the [versioning explanation](./versioning.md) first. Make pull requests to the appropriate branch. -If you want to contribute to [Manual.grid.tf](https://manual.grid.tf/), you should follow this steps: +To contribute to the manual: -1. Add the md file to the appropriate directory in the Docusaurus project structure. +1. Add the Markdown file to the appropriate directory in the Docusaurus project structure. 2. Update the sidebar configuration if needed. 3. Use `yarn start` to preview your changes locally. ## License -This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details. -Copyright (c) TFTech NV. \ No newline at end of file +This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details. +Copyright (c) TF-Tech NV. From 9c9a4a77e963958ed058936eb5b1ab9e8abfbf21 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 10:29:24 +0200 Subject: [PATCH 04/11] docs: rename repository references to new component name --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2ff4750a..57db6d42 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# Info Grid +# Grid Manual A Docusaurus-based documentation site containing user guides, technical references, and FAQ content for grid infrastructure. ## What this is -Info Grid is the primary documentation platform for the decentralized infrastructure stack. It provides comprehensive instructions for operators, developers, and end users interacting with the grid, including farming guides, deployment tutorials, API references, and troubleshooting documentation. +Grid Manual is the primary documentation platform for the decentralized infrastructure stack. It provides comprehensive instructions for operators, developers, and end users interacting with the grid, including farming guides, deployment tutorials, API references, and troubleshooting documentation. The site is built as a static site using Docusaurus and is designed to be the single source of truth for all grid-related documentation. @@ -18,7 +18,7 @@ The site is built as a static site using Docusaurus and is designed to be the si ## Role in the stack -Info Grid sits alongside the operational stack as the user-facing documentation layer. It explains how to use the grid infrastructure, from initial node setup to advanced workload deployment. The documentation is versioned and covers multiple network environments. +Grid Manual sits alongside the operational stack as the user-facing documentation layer. It explains how to use the grid infrastructure, from initial node setup to advanced workload deployment. The documentation is versioned and covers multiple network environments. ## Relation to ThreeFold From 09da88313c2330aa435b626ca10a861dad5da0b8 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 15:39:22 +0200 Subject: [PATCH 05/11] docs: fix LICENSE and remove duplicate copyright from README --- LICENSE | 16 ++-------------- README.md | 1 - 2 files changed, 2 insertions(+), 15 deletions(-) diff --git a/LICENSE b/LICENSE index badbc1d5..f99ca01d 100644 --- a/LICENSE +++ b/LICENSE @@ -173,19 +173,7 @@ incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - END OF TERMS AND CONDITIONS + END OF TERMS AND CONDITIONS - Copyright (c) TFTech NV + Copyright (c) TF-Tech NV Belgian enterprise number = BE 0712.845.674 - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/README.md b/README.md index 57db6d42..c1b9a19a 100644 --- a/README.md +++ b/README.md @@ -102,4 +102,3 @@ To contribute to the manual: ## License This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details. -Copyright (c) TF-Tech NV. From 1e113f7a3cdeda0ef9be0fb1a43be2bf034889be Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 15:44:31 +0200 Subject: [PATCH 06/11] docs: restore complete Apache 2.0 LICENSE with appendix and copyright --- LICENSE | 34 ++++++++++++++++++++++++++++++---- 1 file changed, 30 insertions(+), 4 deletions(-) diff --git a/LICENSE b/LICENSE index f99ca01d..c5bc942b 100644 --- a/LICENSE +++ b/LICENSE @@ -1,3 +1,4 @@ + Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ @@ -48,7 +49,7 @@ "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally - submitted to the Licensor for inclusion in the Work by the copyright owner + submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent @@ -173,7 +174,32 @@ incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. - END OF TERMS AND CONDITIONS + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. - Copyright (c) TF-Tech NV - Belgian enterprise number = BE 0712.845.674 +Copyright (c) TF-Tech NV +Belgian enterprise number = BE 0712.845.674 From b59eff8424af29f30d2d7efeb3da86896356ed5a Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 16:00:54 +0200 Subject: [PATCH 07/11] docs: fix LICENSE copyright format to match canonical --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index c5bc942b..eb1814bf 100644 --- a/LICENSE +++ b/LICENSE @@ -200,6 +200,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. +Copyright TF Tech NV -Copyright (c) TF-Tech NV Belgian enterprise number = BE 0712.845.674 From f87b38c158cc923dfd15a0585871aafd1507458b Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 16:04:21 +0200 Subject: [PATCH 08/11] docs: align LICENSE exactly with canonical format --- LICENSE | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index eb1814bf..ddc752d3 100644 --- a/LICENSE +++ b/LICENSE @@ -200,6 +200,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -Copyright TF Tech NV -Belgian enterprise number = BE 0712.845.674 +Copyright TF Tech NV + Belgian enterprise number = BE 0712.845.674 From 02d494c32ff54114fa3d92ee30a7f5bf1fa1b0c0 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 19:16:46 +0200 Subject: [PATCH 09/11] chore: canonicalize LICENSE --- LICENSE | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/LICENSE b/LICENSE index ddc752d3..6b3991c2 100644 --- a/LICENSE +++ b/LICENSE @@ -187,7 +187,9 @@ same "printed page" as the copyright notice for easier identification within third-party archives. - Copyright [yyyy] [name of copyright owner] + Copyright TF Tech NV + Belgian enterprise number = BE 0712.845.674 + Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. @@ -201,5 +203,3 @@ See the License for the specific language governing permissions and limitations under the License. -Copyright TF Tech NV - Belgian enterprise number = BE 0712.845.674 From d706b35cffaf1ec72874f705e528d90b36c9acf7 Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 19:52:26 +0200 Subject: [PATCH 10/11] chore: canonicalize LICENSE --- LICENSE | 52 ++++++++++++++++++++++------------------------------ 1 file changed, 22 insertions(+), 30 deletions(-) diff --git a/LICENSE b/LICENSE index 6b3991c2..fccc49da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,26 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ + The software in this repository is copyrighted and owned by TF TECH NV. + + Author: TF TECH NV + Belgian Enterprise Number: BE 0712.845.674 + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + + + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION @@ -176,30 +195,3 @@ END OF TERMS AND CONDITIONS - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright TF Tech NV - Belgian enterprise number = BE 0712.845.674 - - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - From a90e3c791512024025393b673e071081dade14af Mon Sep 17 00:00:00 2001 From: despiegk Date: Wed, 27 May 2026 19:58:43 +0200 Subject: [PATCH 11/11] chore: canonicalize LICENSE --- LICENSE | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/LICENSE b/LICENSE index fccc49da..5bdf39c4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,10 +1,14 @@ + The software contained in this repository and all rights, title, and interest + + Copyright © TF TECH NV + Belgian Enterprise Number: BE 0712.845.674 + + Authored and maintained by TF TECH NV. + + TF TECH NV retains ownership of its contributions to this software. - The software in this repository is copyrighted and owned by TF TECH NV. - Author: TF TECH NV - Belgian Enterprise Number: BE 0712.845.674 - - Licensed under the Apache License, Version 2.0 (the "License"); + This software is Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at @@ -17,11 +21,6 @@ limitations under the License. - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions.