tfgrid/info_tfgrid
30
3
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Activity

landing page almost done, needs icons

Browse Source
This commit is contained in:
Mik-TF 2024-06-14 12:30:44 -04:00
parent f23fda2a5f
commit 86e382feaa
12 changed files with 186 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs_projectinca/Makefile Normal file
View File

@ -0,0 +1,3 @@
run:
npm install
npm run dev

121
docs_projectinca/README.md
View File

@ -1,54 +1,103 @@
# Starlight Starter Kit: Basics <h1> Project INCA Docs </h1>
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) <h2>Table of Contents</h2>
- [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) ### Install the prerequisites on MAC or Linux with Brew
[![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! - [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 ### Check if the Prerequisites Are Installed
Inside of your Astro + Starlight project, you'll see the following folders and files:
``` ```
. npm --version
├── public/ git version
├── src/ make --version
│ ├── 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. ## 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 | You can preview the website with those two lines.
| :------------------------ | :----------------------------------------------- |
| `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? ```
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.

8
docs_projectinca/astro.config.mjs
View File

@ -5,16 +5,16 @@ import starlight from '@astrojs/starlight';
export default defineConfig({ export default defineConfig({
integrations: [ integrations: [
starlight({ starlight({
title: 'My Docs', title: 'Project INCA Docs',
social: { social: {
github: 'https://github.com/withastro/starlight', github: 'https://github.com/threefoldtech',
}, },
sidebar: [ sidebar: [
{ {
label: 'Guides', label: 'Start Here',
items: [ items: [
// Each item here is one entry in the navigation menu. // Each item here is one entry in the navigation menu.
{ label: 'Example Guide', link: '/guides/example/' }, { label: 'Getting Started', link: '/start_here/getting_started/' },
], ],
}, },
{ {

54
docs_projectinca/docs_starlight/starlight_README.md Normal file
View File

@ -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).

6
docs_projectinca/package.json
View File

@ -10,10 +10,10 @@
"astro": "astro" "astro": "astro"
}, },
"dependencies": { "dependencies": {
"@astrojs/starlight": "^0.24.1",
"astro": "^4.8.6",
"sharp": "^0.32.5",
"@astrojs/check": "^0.7.0", "@astrojs/check": "^0.7.0",
"@astrojs/starlight": "^0.24.2",
"astro": "^4.10.2",
"sharp": "^0.32.5",
"typescript": "^5.4.5" "typescript": "^5.4.5"
} }
} }

BIN
docs_projectinca/src/assets/black_threefold.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 80 KiB

BIN
docs_projectinca/src/assets/hero_host3.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 670 KiB

BIN
docs_projectinca/src/assets/inca_background.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 87 KiB

11
docs_projectinca/src/content/docs/guides/example.md
View File

@ -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

10
docs_projectinca/src/content/docs/guides/getstarted.md Normal file
View File

@ -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/)

32
docs_projectinca/src/content/docs/index.mdx
View File

@ -1,36 +1,36 @@
--- ---
title: Welcome to Starlight title: Welcome to the Project INCA Docs
description: Get started building your docs site with Starlight. description: Get started building your docs site with Starlight.
template: splash template: splash
hero: hero:
tagline: Congrats on setting up a new Starlight project! tagline: Learn how to deploy INCA nodes to earn rewards!
image: image:
file: ../../assets/houston.webp file: ../../assets/hero_host3.png
actions: actions:
- text: Example Guide - text: Get Started
link: /guides/example/ link: /guides/getstarted/
icon: right-arrow icon: right-arrow
variant: primary variant: primary
- text: Read the Starlight docs - text: Visit the website
link: https://starlight.astro.build link: https://internetcapacity.org/
icon: external icon: external
--- ---
import { Card, CardGrid } from '@astrojs/starlight/components'; import { Card, CardGrid } from '@astrojs/starlight/components';
## Next steps ## Become a Cloud Service Provider
<CardGrid stagger> <CardGrid stagger>
<Card title="Update content" icon="pencil"> <Card title="Learn about INCA" icon="open-book">
Edit `src/content/docs/index.mdx` to see this page change. Read the [INCA Docs](/guides/getstarted) to learn about the ecosystem.
</Card> </Card>
<Card title="Add new content" icon="add-document"> <Card title="Get INCA Nodes" icon="add-document">
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/).
</Card> </Card>
<Card title="Configure your site" icon="setting"> <Card title="Part of a Worldwide Grid" icon="setting">
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!
</Card> </Card>
<Card title="Read the docs" icon="open-book"> <Card title="Earn INCA Rewards" icon="open-book">
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!
</Card> </Card>
</CardGrid> </CardGrid>

10
docs_projectinca/src/content/docs/start_here/getting_started.md Normal file
View File

@ -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/)