diff --git a/LICENSE b/LICENSE index 3d51c6f9..5bdf39c4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,25 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ + 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. + + + 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 + + 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. + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION @@ -175,27 +194,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 2025 ThreeFold - - 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. \ No newline at end of file diff --git a/README.md b/README.md index ace9132e..c1b9a19a 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,38 @@ -# Threefold Grid Manual +# Grid Manual -# 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 + +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. + +## 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 + +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 + +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,31 +70,35 @@ 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. \ 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. 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)