refactor(keywords): better definition

next-hat · Jul 10, 2023 · 75dbc21 · 75dbc21
1 parent cbb6170
commit 75dbc21
Show file tree

Hide file tree

Showing 22 changed files with 32 additions and 42 deletions.
diff --git a/docs/guides/infrastructure/from_locahost_to_vps/containerization.md b/docs/guides/infrastructure/from_locahost_to_vps/containerization.md
@@ -1,7 +1,7 @@
 ---
 title: Containerization
 description: Containerization is a popular technique used in software development and deployment that involves packaging an application and its dependencies into a single, lightweight container. This page provides a tutorial on containerization using Docker and NGINX, including setting up a simple frontend and backend for a project.
-keywords: [containerization, Docker, Kubernetes, Nanocl, NGINX, software development, deployment, frontend, backend, create-react-app, Next.js, Vite, server-side rendering, static site generation]
+keywords: "containerization, Docker, Kubernetes, Nanocl, NGINX, software development, deployment, frontend, backend, create-react-app, Next.js, Vite, server-side rendering, static site generation"
 image: /img/logo.webp
 ---
 

diff --git a/docs/guides/infrastructure/from_locahost_to_vps/expose_your_container.md b/docs/guides/infrastructure/from_locahost_to_vps/expose_your_container.md
@@ -1,7 +1,7 @@
 ---
 title: Expose your container
 description: Learn how to make your containerized frontend and backend applications accessible to the public on different domains using Docker and Nginx.
-keywords: [expose containerized applications, deploy container images, Docker, Nginx, create Docker network, configure Nginx, access container on different domains, frontend, backend]
+keywords: "expose containerized applications, deploy container images, Docker, Nginx, create Docker network, configure Nginx, access container on different domains, frontend, backend"
 ---
 
 To make `my-frontend:0.0.1` accessible at `my-domain.com` and `my-api:0.0.1` at `api.my-domain.com`, make sure you have a VPS or Dedicated/Baremetal server, and that `my-domain.com` and `api.my-domain.com` are pointing to It.<br/>

diff --git a/docs/guides/infrastructure/from_locahost_to_vps/introduction.md b/docs/guides/infrastructure/from_locahost_to_vps/introduction.md
@@ -4,7 +4,7 @@ description: This comprehensive guide walks you through the step-by-step process
 image: /img/logo.webp
 sidebar_label: Introduction
 sidebar_position: 1
-keywords: [deploying, VPS, Baremetal, Dedicated server, Nginx, guide, frontend app, API, Docker containers, configure, create, basic Docker network, redirect traffic, domain, secure, free SSL certificates, Certbot, architecture, services, frontend, backend, performance, scalability, reliability, separation of concerns, development, maintenance, responsiveness]
+keywords: "deploying, VPS, Baremetal, Dedicated server, Nginx, guide, frontend app, API, Docker containers, configure, create, basic Docker network, redirect traffic, domain, secure, free SSL certificates, Certbot, architecture, services, frontend, backend, performance, scalability, reliability, separation of concerns, development, maintenance, responsiveness"
 ---
 
 ## Introduction

diff --git a/docs/guides/nanocl/advanced-usage/ssl.md b/docs/guides/nanocl/advanced-usage/ssl.md
@@ -1,7 +1,7 @@
 ---
 title: SSL / TLS | Nanocl
 description: Use SSL to protect your services.
-keywords: [documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile, ssl, tls, certificate]
+keywords: "documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile, ssl, tls, certificate"
 image: /img/logo.webp
 sidebar_position: 1
 sidebar_label: SSL / TLS

diff --git a/docs/guides/nanocl/advanced-usage/state-args.md b/docs/guides/nanocl/advanced-usage/state-args.md
@@ -1,7 +1,7 @@
 ---
 title: Statefile Args | Nanocl
 description: Use Statefile Args to customize your Nanocl configuration.
-keywords: [documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile]
+keywords: "documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile"
 image: /img/logo.webp
 sidebar_position: 2
 sidebar_label: Statefile Args

diff --git a/docs/guides/nanocl/advanced-usage/virtual-machine.md b/docs/guides/nanocl/advanced-usage/virtual-machine.md
@@ -1,7 +1,7 @@
 ---
 title: Virtual Machine | Nanocl
 description: Create virtual machine with Nanocl
-keywords: [documentation, nanocl, guides, get started, configuration, virtual machines, vm, virtual, machine, statefile, state, file]
+keywords: "documentation, nanocl, guides, get started, configuration, virtual machines, vm, virtual, machine, statefile, state, file"
 image: /img/logo.webp
 sidebar_position: 2
 sidebar_label: Virtual Machine
@@ -67,7 +67,10 @@ The virtual machine will boot with the following default settings if no options
 
 The initial boot time with default settings is approximately 90 seconds. This can be improved by enabling KVM and allocating more resources to your virtual machine.
 
-Note: The virtual machine won't use the base image directly. Instead, it will create a snapshot of the base image and use the snapshot as its own disk.
+> **Note**
+>
+> The virtual machine won't use the base image directly.<br/>
+> Instead, it will create a snapshot of the base image and use the snapshot as its own disk.
 
 You can monitor the status by attaching to the virtual machine using the following command:
 
@@ -127,7 +130,8 @@ In the above command, you can observe several options being utilized:
 
 If your system does not have KVM enabled, you can remove the --kvm option. After patching, you can reattach to the virtual machine.
 
-Note: Patching a virtual machine will cause it to stop and restart.
+> **Note**
+> Patching a virtual machine will cause it to stop and restart.
 
 ## SSH connection
 

diff --git a/docs/guides/nanocl/advanced-usage/vpn.md b/docs/guides/nanocl/advanced-usage/vpn.md
@@ -1,7 +1,7 @@
 ---
 title: Vpn | Nanocl
 description: Use a vpn inside nanocl
-keywords: [documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile, vpn, private network]
+keywords: "documentation, nanocl, guides, get started, configuration, state, file, config, yaml, yml, statefile, vpn, private network"
 image: /img/logo.webp
 sidebar_position: 3
 sidebar_label: Your own VPN

diff --git a/docs/guides/nanocl/get-started/configure-your-proxy.md b/docs/guides/nanocl/get-started/configure-your-proxy.md
@@ -1,7 +1,7 @@
 ---
 title: Configure your proxy | Nanocl
 description: Configure your proxy to expose your cargo
-keywords: [documentation, nanocl, guides, get started, proxy, configuration]
+keywords: "documentation, nanocl, guides, get started, proxy, configuration"
 image: /img/logo.webp
 sidebar_position: 3
 sidebar_label: 3. Configure your proxy

diff --git a/docs/guides/nanocl/get-started/orientation-and-setup.md b/docs/guides/nanocl/get-started/orientation-and-setup.md
@@ -1,7 +1,7 @@
 ---
 title: Orientation and Setup | Nanocl
 description: This page contains step-by-step instructions on how to get started with Nanocl.
-keywords: [documentation, guides, nanocl, get started, orientation and setup]
+keywords: "documentation, guides, nanocl, get started, orientation and setup"
 image: /img/logo.webp
 sidebar_position: 1
 sidebar_label: 1. Orientation and Setup

diff --git a/docs/guides/nanocl/get-started/patch-a-cargo.md b/docs/guides/nanocl/get-started/patch-a-cargo.md
@@ -1,7 +1,7 @@
 ---
 title: Patch a cargo | Nanocl
 description: Patch a cargo to update his image or his environnements variables and redeploy them instantly.
-keywords: [documentation, guides. nanocl, get started, cargo, patch, update]
+keywords: "documentation, guides. nanocl, get started, cargo, patch, update"
 image: /img/logo.webp
 sidebar_position: 2
 sidebar_label: 2. Patch a cargo

diff --git a/docs/guides/nanocl/get-started/state-file.md b/docs/guides/nanocl/get-started/state-file.md
@@ -1,7 +1,7 @@
 ---
 title: Statefile | Nanocl
 description: Use Statefile to manage your state
-keywords: [documentation, nanocl, guides, get started, proxy, configuration, state, file, config, yaml, yml, statefile]
+keywords: "documentation, nanocl, guides, get started, proxy, configuration, state, file, config, yaml, yml, statefile"
 image: /img/logo.webp
 sidebar_position: 4
 sidebar_label: 4. Use Statefile

diff --git a/docs/guides/nanocl/overview.md b/docs/guides/nanocl/overview.md
@@ -1,6 +1,6 @@
 ---
 title: Overview
-keywords: [documentation, nanocl, guides, get started, overview]
+keywords: "documentation, nanocl, guides, get started, overview"
 image: /img/logo.webp
 sidebar_position: 1
 ---

diff --git a/docs/references/c2ncl/cli.md b/docs/references/c2ncl/cli.md
@@ -1,7 +1,7 @@
 ---
 title: C2ncl CLI References
 description: To list available commands, either run c2ncl with no parameters or execute c2ncl --help
-keywords: [documentation, references, nanocl, nanocl CLI, CLI, C2ncl, convert docker compose to nanocl, docker compose, statefile]
+keywords: "documentation, references, nanocl, nanocl CLI, CLI, C2ncl, convert docker compose to nanocl, docker compose, statefile"
 image: /img/logo.webp
 sidebar_label: CLI
 sidebar_position: 1

diff --git a/docs/references/nanocl/cargo.md b/docs/references/nanocl/cargo.md
@@ -1,6 +1,6 @@
 ---
 title: Nanocl Cargo References
-keywords: [documentation, references, nanocl, nanocld, cargo, specification, spec]
+keywords: "documentation, references, nanocl, nanocld, cargo, specification, spec"
 image: /img/logo.webp
 sidebar_label: Cargo
 sidebar_position: 3

diff --git a/docs/references/nanocl/cli.md b/docs/references/nanocl/cli.md
@@ -1,7 +1,7 @@
 ---
 title: Nanocl CLI References
 description: To list available commands, either run nanocl with no parameters or execute nanocl help
-keywords: [documentation, references, nanocl, nanocl CLI, CLI]
+keywords: "documentation, references, nanocl, nanocl CLI, CLI"
 image: /img/logo.webp
 sidebar_label: CLI
 sidebar_position: 1

diff --git a/docs/references/nanocl/daemon/overview.md b/docs/references/nanocl/daemon/overview.md
@@ -1,6 +1,6 @@
 ---
 description: Nanocl DAEMON References, to list available options, run nanocld --help
-keywords: [documentation, references, nanocl, nanocld, nanocl DAEMON, DAEMON]
+keywords: "documentation, references, nanocl, nanocld, nanocl DAEMON, DAEMON"
 image: /img/logo.webp
 sidebar_label: Overview
 ---
@@ -17,7 +17,7 @@ To list available options, run `nanocld --help` :
 
 ```console
 $ nanocld --help
-Nanocl daemon Self Sufficient Hybrid Cloud Orchestrator
+Nanocl Daemon - Self Sufficient Hybrid Cloud Orchestrator
 
 Usage: nanocld [OPTIONS]
 
@@ -27,7 +27,7 @@ Options:
  -H, --hosts <HOSTS>
  Hosts to listen to use tcp:// and unix:// [default: unix:///run/nanocl.sock]
  --docker-host <DOCKER_HOST>
- Docker daemon socket to connect [default: unix:///run/docker.sock]
+ Docker daemon socket to connect [default: unix:///var/run/docker.sock]
  --state-dir <STATE_DIR>
  State directory [default: /var/lib/nanocl]
  --conf-dir <CONF_DIR>
@@ -40,6 +40,8 @@ Options:
  Join current node to a cluster
  --advertise-addr <ADVERTISE_ADDR>
  Address to advertise to other nodes
+ --gid <GID>
+ Group id [default: 0]
  -h, --help
  Print help
  -V, --version
@@ -57,19 +59,3 @@ Options:
 | **\--config-dir**=*CONFIG\_DIR* | /etc/nanocl | Config directory
 | **-h**, **\--help** | | Print help information
 | **-V**, **\--version** | | Print version information
-
-
-## Config Directory
-
-Nanocld use a config file inside a config directory by default located at `/etc/nanocl`. <br />
-It will look for a file called `nanocl.conf` and have a `yml` format.
-
-For example :
-
-```yaml
-docker_host: unix:///run/docker.sock
-github_user: my_user
-github_token: my_token
-hosts: unix:///run/nanocl.sock
-state_dir: /var/lib/nanocl
-```
diff --git a/docs/references/nanocl/resource.md b/docs/references/nanocl/resource.md
@@ -1,6 +1,6 @@
 ---
 title: Nanocl Resource References
-keywords: [documentation, references, nanocl, nanocld, resource, specification]
+keywords: "documentation, references, nanocl, nanocld, resource, specification"
 image: /img/logo.webp
 sidebar_label: Resource
 sidebar_position: 4

diff --git a/docs/references/nanocl/virtual-machine.md b/docs/references/nanocl/virtual-machine.md
@@ -1,6 +1,6 @@
 ---
 title: Virtual Machine References | Nanocl
-keywords: [documentation, references, nanocl, nanocld, virtual machine, vm, vms, specification, spec]
+keywords: "documentation, references, nanocl, nanocld, virtual machine, vm, vms, specification, spec"
 image: /img/logo.webp
 sidebar_label: Virtual Machine
 sidebar_position: 3

diff --git a/docs/references/summary.md b/docs/references/summary.md
@@ -1,7 +1,7 @@
 ---
 title: Next Hat References
 description: This section include the summary of references and manual page for Next Hat based product and tools.
-keywords: [documentation, cli, references, manual, man, man page]
+keywords: "documentation, cli, references, manual, man, man page"
 image: /img/logo.webp
 ---
 

diff --git a/docs/setups/nanocl/linux/post-installation.md b/docs/setups/nanocl/linux/post-installation.md
@@ -1,7 +1,7 @@
 ---
 title: Nanocl post installation
 description: This section contains required procedures for configuring Nanocl after installation.
-keywords: [documentation, nanocl , setup, installation, post installation]
+keywords: "documentation, nanocl , setup, installation, post installation"
 image: /img/logo.webp
 sidebar_position: 3
 sidebar_label: Post Installation

diff --git a/docs/setups/nanocl/linux/ubuntu.md b/docs/setups/nanocl/linux/ubuntu.md
@@ -1,7 +1,7 @@
 ---
 title: Install Nanocl on Ubuntu
 description: This section contains required procedures for installaling Nanocl on Ubuntu.
-keywords: [documentation, nanocl , setup, installation, ubuntu]
+keywords: "documentation, nanocl , setup, installation, ubuntu"
 image: /img/logo.webp
 sidebar_position: 1
 sidebar_label: Ubuntu / Debian

diff --git a/docs/setups/summary.md b/docs/setups/summary.md
@@ -1,7 +1,7 @@
 ---
 sidebar_label: Summary
 description: This section include the summary setups for Next Hat products and tools.
-keywords: [documentation, setups, summary]
+keywords: "documentation, setups, summary"
 image: /img/logo.webp
 pagination_next: null
 pagination_prev: null