doc: New folder structure

neterialio · Feb 10, 2025 · 1418bf7 · 1418bf7
1 parent 03422a1
commit 1418bf7
Show file tree

Hide file tree

Showing 19 changed files with 53 additions and 77 deletions.
diff --git a/API-keys/Hetzner/index.md b/API-keys/Hetzner/index.md
diff --git a/API-keys/index.md b/API-keys/index.md
diff --git a/CLI/README.md → CLI.md b/CLI/README.md → CLI.md
diff --git a/Cloud-providers/README.md b/Cloud-providers/README.md
@@ -0,0 +1,10 @@
+Cloud providers
+===============
+
+To enable us to create Kubernetes clusters, you need to add access keys for cloud provider APIs to the system.
+Using these keys, we will create virtual machines, load balancers, and disks for your clusters.
+
+Below are the instructions for Hetzner Cloud and Amazon Web Services.
+
+* [Connect Hetzner cloud](Cloud-providers/connect-hetzner-cloud.md)
+* [Connect AWS](Cloud-providers/connect-aws.md)
diff --git a/API-keys/AWS/index.md → Cloud-providers/connect-aws.md b/API-keys/AWS/index.md → Cloud-providers/connect-aws.md
@@ -1,4 +1,7 @@
-# Generating an API tokens
+Connect AWS
+===========
+
+## Generating an API tokens
 
 1. Open the [AWS Management Console](https://console.aws.amazon.com) and sign in using your root user credentials. For instructions, see [Sign in to the AWS Management Console as the root user](https://docs.aws.amazon.com/signin/latest/userguide/introduction-to-root-user-sign-in-tutorial.html) in the *AWS Sign-In User Guide*.
 2. In the upper right corner of the console, choose your account name or number and then choose **Security Credentials**.

diff --git a/Hetzner.md → Cloud-providers/connect-hetzner-cloud.md b/Hetzner.md → Cloud-providers/connect-hetzner-cloud.md
@@ -1,4 +1,7 @@
-# Generating an API token
+Connect Hetzner Cloud
+=====================
+
+## Generating an API token
 
 To generate an API token on your [Cloud Console](https://console.hetzner.cloud/), please open your project and do the following:
 
@@ -41,4 +44,3 @@ curl \
 	-H "Authorization: Bearer $API_TOKEN" \
     ...
 ```
-
diff --git a/API-keys/Hetzner/img/api-tokens.png → Cloud-providers/img/api-tokens.png b/API-keys/Hetzner/img/api-tokens.png → Cloud-providers/img/api-tokens.png
diff --git a/API-keys/Hetzner/img/copy-api-token.png → Cloud-providers/img/copy-api-token.png b/API-keys/Hetzner/img/copy-api-token.png → Cloud-providers/img/copy-api-token.png
diff --git a/...eys/Hetzner/img/dashboard.security.en.png → ...d-providers/img/dashboard.security.en.png b/...eys/Hetzner/img/dashboard.security.en.png → ...d-providers/img/dashboard.security.en.png
diff --git a/API-keys/Hetzner/img/generate-api-token.png → Cloud-providers/img/generate-api-token.png b/API-keys/Hetzner/img/generate-api-token.png → Cloud-providers/img/generate-api-token.png
diff --git a/...eys/Hetzner/img/select-generate-token.png → ...d-providers/img/select-generate-token.png b/...eys/Hetzner/img/select-generate-token.png → ...d-providers/img/select-generate-token.png
diff --git a/Guides/README.md b/Guides/README.md
@@ -0,0 +1,5 @@
+Installation guides
+===================
+
+* [ingress-nginx](./Guides/ingress-nginx/index)
+* [CertManager](./Guides/cert-manager.md)
diff --git a/Guides/CertManager/index.md → Guides/cert-manager.md b/Guides/CertManager/index.md → Guides/cert-manager.md
diff --git a/Guides/ingress-nginx/img/hetzner-lb.png → Guides/img/hetzner-lb.png b/Guides/ingress-nginx/img/hetzner-lb.png → Guides/img/hetzner-lb.png
diff --git a/Guides/index.md b/Guides/index.md
diff --git a/Guides/ingress-nginx/index.md → Guides/ingress-nginx.md b/Guides/ingress-nginx/index.md → Guides/ingress-nginx.md
diff --git a/README.md b/README.md
@@ -1,17 +1,21 @@
-# Neterial documentation
+Neterial documentation
+======================
 
 Everything you need to know about Neterial.
 
-# Getting help
+## Connect your cloud
 
-Having trouble? We’d like to help!
+We use the BYOC (Bring-Your-Own-Cloud) model, so you need to connect your cloud to our system.
 
-* Try the [FAQ](/FAQ) – it’s got answers to many common questions.
-* Looking for specific information? Try the Index, Module Index or the detailed table of contents.
-* Not found anything? See FAQ: Getting Help for information on getting support and asking questions to the community.
-* Report bugs with Django in our ticket tracker.
+* [Connect Hetzner Cloud](Cloud-providers/connect-hetzner-cloud.md)
+* [Connect AWS](Cloud-providers/connect-aws.md)
 
-# How the documentation is organized
+## Our guides
 
-Neterial has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things:
+* [Install Ingress NGINX](Guides/ingress-nginx.md)
+* [Install cert-manager](Guides/cert-manager.md)
+
+## About us
+
+* [About](about.md) – Basic information 
 
diff --git a/_sidebar.md b/_sidebar.md
@@ -1,10 +1,17 @@
 <!-- docs/_sidebar.md -->
 * [HOME](./)
-* [API keys](./API-keys/index)
-  * [Hetzner](./API-keys/Hetzner/index)
-  * [AWS](./API-keys/AWS/index)
-* [Guides](./Guides/index)
-  * [Ingress-nginx](./Guides/ingress-nginx/index)
-  * [CertManager](./Guides/CertManager/index)
-* [CLI](CLI/)
-* [About](./About/index)
+<!-- * [How it works](how-it-works.md) -->
+<!-- * [Get started](Get-started/) -->
+<!--  * [Create cluster](Get-started/create-cluster.md) -->
+<!--  * [Deploy your first app](Get-started/deploy-app.md) -->
+* [Cloud providers](Cloud-providers/)
+  * [Connect Hetzner Cloud](Cloud-providers/connect-hetzner-cloud.md)
+  * [Connect AWS](Cloud-providers/connect-aws.md)
+<!--  * [Increase quotas](./Cloud-providers/quotas.md) -->
+* [Guides](Guides/)
+  * [Install Ingress NGINX](Guides/ingress-nginx.md)
+  * [Install cert-manager](Guides/cert-manager.md)
+<!--  * [Use GitHub registry](./Guides/use-gh-registry.md) -->
+* [CLI](CLI.md)
+<!-- * [FAQ](FAQ.md) -->
+* [About](about.md)
diff --git a/About/index.md → about.md b/About/index.md → about.md
@@ -1,4 +1,5 @@
-# About
+About
+=====
 
 We help early-stage startups focused on developing their MVP to save money on cloud services. Entrepreneurs often struggle to deploy cloud infrastructure for their MVP in the most cost-efficient way. Options such as AWS, GCP, Azure may not be viable due to their extremely high costs, even with free tiers available. Alternatively, other solutions may require expertise to deploy all the necessary tools on your own.
-Original file line number
+Diff line change
@@ -1,4 +1,5 @@
-    # About
+    About
+    =====
     We help early-stage startups focused on developing their MVP to save money on cloud services. Entrepreneurs often struggle to deploy cloud infrastructure for their MVP in the most cost-efficient way. Options such as AWS, GCP, Azure may not be viable due to their extremely high costs, even with free tiers available. Alternatively, other solutions may require expertise to deploy all the necessary tools on your own.
@@ Expand Down @@