Skip to content

Commit e9dc78b

Browse files
authored
feat: UI overhaul (#20)
* feat: docs restructuring * yet better structures these commit messages suck ik it doesnt matter it's just md docs * final homepage cleanup
1 parent cbb6d12 commit e9dc78b

33 files changed

+5631
-7441
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
1-
# Website
1+
# PoliNetwork Docs
2+
3+
Welcome to the PoliNetwork documentation site. Here you will find guides, tutorials,
4+
and other resources to help you get started with contributing to PoliNetwork's projects.
5+
6+
## Website
27

38
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
49

510
### Installation
611

7-
```
8-
$ yarn
12+
```sh
13+
pnpm install
914
```
1015

1116
### Local Development
1217

13-
```
14-
$ yarn start
18+
```sh
19+
pnpm start
1520
```
1621

1722
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1823

1924
### Build
2025

21-
```
22-
$ yarn build
26+
```sh
27+
pnpm build
2328
```
2429

2530
This command generates static content into the `build` directory and can be served using any static contents hosting service.
2631

27-
### Deployment
28-
29-
Using SSH:
32+
You can then serve your static build by running:
3033

34+
```sh
35+
pnpm serve
3136
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
3637

37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
38+
### Deployment
4039

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
40+
This website is deployed using GitHub Pages. The deployment process is automated using GitHub Actions.

docs/Infra/_category_.json

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,22 @@ Let's discover **PoliNetwork's Infrastructure in less than 5 minutes**.
99
## Getting Started
1010

1111
### Where
12+
1213
Our infrastructure is deployed on Azure West Europe (Amsterdam).
1314
The description is found [here](https://github.com/polinetworkorg/terraform), described in Terraform (IaC).
1415

1516
### What
17+
1618
The core is a AKS Cluster (Kubernetes), in combination with various other services (KeyVault, Disks, Azure Active Directory, ...)
1719

1820
### Why
21+
1922
Why not a simple VM?
20-
AKS gives us the flexibility of a 10s pod deployment, reliability (with ArgoCD ensuring all pods are up and running all the time) and allows us to be more precise and clean in our infrastructure, with better monitoring and allocated resources for each application depending on the importance.
23+
AKS gives us the flexibility of a 10s pod deployment, reliability (with ArgoCD ensuring all pods are up and running all the time) and allows us to be more precise and clean in our infrastructure, with better monitoring and allocated resources for each application depending on the importance.
24+
25+
## About this documentation
26+
27+
The best place to start is going through the [Tutorials](./Tutorials/setup) section to get a high level overview of how things are organized.
28+
29+
If you're looking for a guide on how to achieve a specific outcome, you can look in the [How To Guides](./How%20To%20Guides/Adding%20a%20Secret).
30+

docs/Infra/k8s-basics/_category_.json renamed to docs/infrastructure/02-Tutorials/k8s-basics/_category_.json

File renamed without changes.

docs/Infra/k8s-basics/day-to-day/monitoring.md renamed to docs/infrastructure/02-Tutorials/k8s-basics/day-to-day/monitoring.md

File renamed without changes.

docs/Infra/k8s-basics/day-to-day/ssh.md renamed to docs/infrastructure/02-Tutorials/k8s-basics/day-to-day/ssh.md

File renamed without changes.

docs/Infra/k8s-basics/intro.md renamed to docs/infrastructure/02-Tutorials/k8s-basics/intro.md

File renamed without changes.

docs/Infra/pipelines/_category_.json renamed to docs/infrastructure/02-Tutorials/pipelines/_category_.json

File renamed without changes.

docs/Infra/pipelines/cd.md renamed to docs/infrastructure/02-Tutorials/pipelines/cd.md

File renamed without changes.

docs/Infra/pipelines/ci.md renamed to docs/infrastructure/02-Tutorials/pipelines/ci.md

File renamed without changes.

0 commit comments

Comments
 (0)