diff --git a/docs_projectinca/Makefile b/docs_projectinca/Makefile new file mode 100644 index 0000000..202b232 --- /dev/null +++ b/docs_projectinca/Makefile @@ -0,0 +1,3 @@ +run: + npm install + npm run dev diff --git a/docs_projectinca/README.md b/docs_projectinca/README.md index b51abaa..4bc2272 100644 --- a/docs_projectinca/README.md +++ b/docs_projectinca/README.md @@ -1,54 +1,103 @@ -# Starlight Starter Kit: Basics +

Project INCA Docs

-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) +

Table of Contents

+- [Introduction](#introduction) +- [Prerequisites](#prerequisites) + - [Install the prerequisites on Ubuntu](#install-the-prerequisites-on-ubuntu) + - [Install the prerequisites on MAC or Linux with Brew](#install-the-prerequisites-on-mac-or-linux-with-brew) + - [Check if the Prerequisites Are Installed](#check-if-the-prerequisites-are-installed) +- [Clone the Repository](#clone-the-repository) +- [Preview the Website](#preview-the-website) +- [License](#license) +- [References](#references) +- [Contribute](#contribute) + +--- + +## Introduction + +This subrepository contains the code to deploy the Project INCA Docs website, a project by [ThreeFold](https://threefold.io). + +## Prerequisites + +You need [npm](https://www.npmjs.com/) to run this website. + +To clone the repository, you need `git`. + +To use the Makefile for quick deployment, you need `make` + +### Install the prerequisites on Ubuntu ``` -npm create astro@latest -- --template starlight +sudo apt update +sudo apt install nodejs +sudo apt install git +sudo apt install make ``` -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs) +### Install the prerequisites on MAC or Linux with Brew -> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! +- [Install Brew](https://brew.sh/) + ``` + /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" + ``` +- Install the prerequisites + ``` + brew install node + brew install git + brew install make + ``` -## πŸš€ Project Structure - -Inside of your Astro + Starlight project, you'll see the following folders and files: +### Check if the Prerequisites Are Installed ``` -. -β”œβ”€β”€ public/ -β”œβ”€β”€ src/ -β”‚ β”œβ”€β”€ assets/ -β”‚ β”œβ”€β”€ content/ -β”‚ β”‚ β”œβ”€β”€ docs/ -β”‚ β”‚ └── config.ts -β”‚ └── env.d.ts -β”œβ”€β”€ astro.config.mjs -β”œβ”€β”€ package.json -└── tsconfig.json +npm --version +git version +make --version ``` -Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. +## Clone the Repository -Images can be added to `src/assets/` and embedded in Markdown with a relative link. -Static assets, like favicons, can be placed in the `public/` directory. +``` +git clone https://git.ourworld.tf/tfgrid/info_tfgrid +cd info_tfgrid/docs_projectinca +``` -## 🧞 Commands +For more information, read the original [AstroWind docs](./docs_starlight/starlight_README.md). -All commands are run from the root of the project, from a terminal: +## Preview the Website -| Command | Action | -| :------------------------ | :----------------------------------------------- | -| `npm install` | Installs dependencies | -| `npm run dev` | Starts local dev server at `localhost:4321` | -| `npm run build` | Build your production site to `./dist/` | -| `npm run preview` | Preview your build locally, before deploying | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | -| `npm run astro -- --help` | Get help using the Astro CLI | +You can preview the website with those two lines. -## πŸ‘€ Want to learn more? +``` +npm install +npm run dev +``` -Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). +The equivalent can be achieved using the Makefile: + +``` +make run +``` + +## License + +**INCA Docs** is licensed under the Apache 2.0 license β€” see the [LICENSE](../LICENSE.md) file for details. + +## References + +This Project INCA Docs website is based on the amazing [AstroWind Starlight repo](https://github.com/withastro/starlight). + +We changed the license from MIT to Apache 2.0 to suit this specific project. + +## Contribute + +To contribute to this repository: + +- Make a new branch with `development_` as a prefix (e.g. `development_update`) +- Make changes locally on your code editor +- Push changes to the new branch +- Make a pull request to `development` branch + +The code owners will merge `development` branch to `main` branch. \ No newline at end of file diff --git a/docs_projectinca/astro.config.mjs b/docs_projectinca/astro.config.mjs index 9eacfd1..854d0f3 100644 --- a/docs_projectinca/astro.config.mjs +++ b/docs_projectinca/astro.config.mjs @@ -5,16 +5,16 @@ import starlight from '@astrojs/starlight'; export default defineConfig({ integrations: [ starlight({ - title: 'My Docs', + title: 'Project INCA Docs', social: { - github: 'https://github.com/withastro/starlight', + github: 'https://github.com/threefoldtech', }, sidebar: [ { - label: 'Guides', + label: 'Start Here', items: [ // Each item here is one entry in the navigation menu. - { label: 'Example Guide', link: '/guides/example/' }, + { label: 'Getting Started', link: '/start_here/getting_started/' }, ], }, { diff --git a/docs_projectinca/docs_starlight/starlight_README.md b/docs_projectinca/docs_starlight/starlight_README.md new file mode 100644 index 0000000..b51abaa --- /dev/null +++ b/docs_projectinca/docs_starlight/starlight_README.md @@ -0,0 +1,54 @@ +# Starlight Starter Kit: Basics + +[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) + +``` +npm create astro@latest -- --template starlight +``` + +[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics) +[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics) +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs) + +> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun! + +## πŸš€ Project Structure + +Inside of your Astro + Starlight project, you'll see the following folders and files: + +``` +. +β”œβ”€β”€ public/ +β”œβ”€β”€ src/ +β”‚ β”œβ”€β”€ assets/ +β”‚ β”œβ”€β”€ content/ +β”‚ β”‚ β”œβ”€β”€ docs/ +β”‚ β”‚ └── config.ts +β”‚ └── env.d.ts +β”œβ”€β”€ astro.config.mjs +β”œβ”€β”€ package.json +└── tsconfig.json +``` + +Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name. + +Images can be added to `src/assets/` and embedded in Markdown with a relative link. + +Static assets, like favicons, can be placed in the `public/` directory. + +## 🧞 Commands + +All commands are run from the root of the project, from a terminal: + +| Command | Action | +| :------------------------ | :----------------------------------------------- | +| `npm install` | Installs dependencies | +| `npm run dev` | Starts local dev server at `localhost:4321` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | +| `npm run astro -- --help` | Get help using the Astro CLI | + +## πŸ‘€ Want to learn more? + +Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat). diff --git a/docs_projectinca/package.json b/docs_projectinca/package.json index 76174e4..a267703 100644 --- a/docs_projectinca/package.json +++ b/docs_projectinca/package.json @@ -10,10 +10,10 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.24.1", - "astro": "^4.8.6", - "sharp": "^0.32.5", "@astrojs/check": "^0.7.0", + "@astrojs/starlight": "^0.24.2", + "astro": "^4.10.2", + "sharp": "^0.32.5", "typescript": "^5.4.5" } -} \ No newline at end of file +} diff --git a/docs_projectinca/src/assets/black_threefold.png b/docs_projectinca/src/assets/black_threefold.png new file mode 100644 index 0000000..ae46096 Binary files /dev/null and b/docs_projectinca/src/assets/black_threefold.png differ diff --git a/docs_projectinca/src/assets/hero_host3.png b/docs_projectinca/src/assets/hero_host3.png new file mode 100644 index 0000000..6fc9e4c Binary files /dev/null and b/docs_projectinca/src/assets/hero_host3.png differ diff --git a/docs_projectinca/src/assets/inca_background.webp b/docs_projectinca/src/assets/inca_background.webp new file mode 100644 index 0000000..57e5f5c Binary files /dev/null and b/docs_projectinca/src/assets/inca_background.webp differ diff --git a/docs_projectinca/src/content/docs/guides/example.md b/docs_projectinca/src/content/docs/guides/example.md deleted file mode 100644 index ebd0f3b..0000000 --- a/docs_projectinca/src/content/docs/guides/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Guide -description: A guide in my new Starlight docs site. ---- - -Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. -Writing a good guide requires thinking about what your users are trying to do. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the DiΓ‘taxis framework diff --git a/docs_projectinca/src/content/docs/guides/getstarted.md b/docs_projectinca/src/content/docs/guides/getstarted.md new file mode 100644 index 0000000..f4052a7 --- /dev/null +++ b/docs_projectinca/src/content/docs/guides/getstarted.md @@ -0,0 +1,10 @@ +--- +title: Get Started +description: Earn INCA rewards by hosting nodes +--- + +Earn INCA rewards by hosting nodes + +## Get a Node + +- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/) diff --git a/docs_projectinca/src/content/docs/index.mdx b/docs_projectinca/src/content/docs/index.mdx index 117179d..58ec3f2 100644 --- a/docs_projectinca/src/content/docs/index.mdx +++ b/docs_projectinca/src/content/docs/index.mdx @@ -1,36 +1,36 @@ --- -title: Welcome to Starlight +title: Welcome to the Project INCA Docs description: Get started building your docs site with Starlight. template: splash hero: - tagline: Congrats on setting up a new Starlight project! + tagline: Learn how to deploy INCA nodes to earn rewards! image: - file: ../../assets/houston.webp + file: ../../assets/hero_host3.png actions: - - text: Example Guide - link: /guides/example/ + - text: Get Started + link: /guides/getstarted/ icon: right-arrow variant: primary - - text: Read the Starlight docs - link: https://starlight.astro.build + - text: Visit the website + link: https://internetcapacity.org/ icon: external --- import { Card, CardGrid } from '@astrojs/starlight/components'; -## Next steps +## Become a Cloud Service Provider - - Edit `src/content/docs/index.mdx` to see this page change. + + Read the [INCA Docs](/guides/getstarted) to learn about the ecosystem. - - Add Markdown or MDX files to `src/content/docs` to create new pages. + + You can get INCA nodes at the [official INCA website](https://internetcapacity.org/farming/). - - Edit your `sidebar` and other config in `astro.config.mjs`. + + Project INCA is the fourth version of the [ThreeFold Grid](https://threefold.io/) available in 60+ countries! - - Learn more in [the Starlight Docs](https://starlight.astro.build/). + + When you deploy INCA nodes, you contribute to the growth of the grid and earn INCA rewards! diff --git a/docs_projectinca/src/content/docs/start_here/getting_started.md b/docs_projectinca/src/content/docs/start_here/getting_started.md new file mode 100644 index 0000000..f4052a7 --- /dev/null +++ b/docs_projectinca/src/content/docs/start_here/getting_started.md @@ -0,0 +1,10 @@ +--- +title: Get Started +description: Earn INCA rewards by hosting nodes +--- + +Earn INCA rewards by hosting nodes + +## Get a Node + +- Visit the official INCA website to [get INCA nodes](https://internetcapacity.org/)