From 604f55ccecd2387541464b533a0b2ad2953b6aae Mon Sep 17 00:00:00 2001 From: Alice Rhodes Date: Wed, 23 Aug 2023 12:24:30 -0400 Subject: [PATCH] Reorganizing pages - framework pages are now under docs - removed pages that just dupe repo content - made the code repositories pages the download page - docs home page advertising the documentation work push --- pages/docs/accessibility.md | 2 +- pages/{framework => docs}/cryptography.md | 2 +- pages/docs/debian-install.md | 98 ------------------- pages/docs/fedora-install.md | 18 ---- pages/docs/index.md | 18 +--- pages/{framework => docs}/networking.md | 2 +- .../{framework/index.md => docs/overview.md} | 7 +- pages/docs/package-repositories.md | 12 --- pages/{framework => docs}/private-routing.md | 2 +- pages/{framework => docs}/rpc.md | 2 +- .../code-repositories.md => download.md} | 18 ++-- 11 files changed, 18 insertions(+), 163 deletions(-) rename pages/{framework => docs}/cryptography.md (99%) delete mode 100644 pages/docs/debian-install.md delete mode 100644 pages/docs/fedora-install.md rename pages/{framework => docs}/networking.md (99%) rename pages/{framework/index.md => docs/overview.md} (93%) delete mode 100644 pages/docs/package-repositories.md rename pages/{framework => docs}/private-routing.md (99%) rename pages/{framework => docs}/rpc.md (99%) rename pages/{docs/code-repositories.md => download.md} (78%) diff --git a/pages/docs/accessibility.md b/pages/docs/accessibility.md index 164d33d..3c562a3 100644 --- a/pages/docs/accessibility.md +++ b/pages/docs/accessibility.md @@ -1,7 +1,7 @@ --- title: Accessibility description: An introduction to accessibility concepts and resources -weight: 7 +weight: 30 layout: subpage --- diff --git a/pages/framework/cryptography.md b/pages/docs/cryptography.md similarity index 99% rename from pages/framework/cryptography.md rename to pages/docs/cryptography.md index 90d466c..974563d 100644 --- a/pages/framework/cryptography.md +++ b/pages/docs/cryptography.md @@ -1,7 +1,7 @@ --- title: Cryptography description: An overview of the cryptography used in Veilid -weight: 3 +weight: 23 layout: subpage --- diff --git a/pages/docs/debian-install.md b/pages/docs/debian-install.md deleted file mode 100644 index 0c51a0b..0000000 --- a/pages/docs/debian-install.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: Debian Install -description: How to install `veilid-server` and `veilid-cli` on Debian based systems -weight: 3 -layout: subpage ---- - -### Step 1 - -Add the GPG keys to your operating systems keyring. - -_Explanation_: The wget command downloads the public key, and the sudo gpg command adds the public key to the keyring. - -
- - -
- -### Step 2 - -Identify your architecture - -_Explanation_: The following command will tell you what type of CPU your system is running - -
- - -
- -### Step 3 - -Add Veilid to your list of available software. - -_Explanation_: Using the command in Step 2 you will need to run one of the following: - -- For **AMD**64 based systems run this command: - -
- - -
- -- For **ARM**64 based systems run this command: - -
- - -
- -_Explanation_: Each of the above commands will create a new file called `veilid.list` in the `/etc/apt/sources.list.d/`. This file contains instructions that tell the operating system where to download Veilid. - -### Step 4 - -Refresh the package manager. - -_Explanation_: This tells the `apt` package manager to rebuild the list of available software using the files in `/etc/apt/sources.list.d/` directory - -
- - -
- -#### Step 5 - -Install Veilid. - -_Explanation_: With the package manager updated, it is now possible to install Veilid! - -
- - -
- -
- -The remaining steps are optional. - -### Step 6 - -Start `veilid-server.service` manually - -
- - -
- -### Step 7 - -Set up `veilid-server.service` to start at boot - -
- - -
- - - - diff --git a/pages/docs/fedora-install.md b/pages/docs/fedora-install.md deleted file mode 100644 index e403613..0000000 --- a/pages/docs/fedora-install.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Fedora Install -description: How to install `veilid-server` and `veilid-cli` on Fedora based systems -weight: 4 -layout: subpage ---- - -

Fedora Based Systems

- -
- - -
- -
- - -
\ No newline at end of file diff --git a/pages/docs/index.md b/pages/docs/index.md index a9a7c9f..11e99d4 100644 --- a/pages/docs/index.md +++ b/pages/docs/index.md @@ -12,20 +12,10 @@ The documentation is currently a work in progress. Are you good at writing? We could use your help. -### Available Documentation +### Documentation Week -- Slides from DefCon: [Download PDF](/Launch-Slides-Veilid.pdf) -- [Checkout the Code](/docs/code-repositories/) -- [Install from Packages](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md) +Starting Saturday August 28th, we are having a big documentation work week. The project leads will be getting the information out of their heads and into core documentation. +We're looking to the community to help write out additional documentation, tutorials, and guides. - \ No newline at end of file +Check out the #documentation channel on our [Discord server](/discord). \ No newline at end of file diff --git a/pages/framework/networking.md b/pages/docs/networking.md similarity index 99% rename from pages/framework/networking.md rename to pages/docs/networking.md index e1e3456..02b97e0 100644 --- a/pages/framework/networking.md +++ b/pages/docs/networking.md @@ -1,7 +1,7 @@ --- title: Networking description: An overview of the networking used in Veilid -weight: 2 +weight: 22 layout: subpage --- diff --git a/pages/framework/index.md b/pages/docs/overview.md similarity index 93% rename from pages/framework/index.md rename to pages/docs/overview.md index 4a66813..f6a5c75 100644 --- a/pages/framework/index.md +++ b/pages/docs/overview.md @@ -1,10 +1,7 @@ --- -title: Framework +title: Framework Overview description: An overview of the Veilid Framework -menu: - main: - weight: 3 -weight: 1 +weight: 20 layout: subpage sortby: weight --- diff --git a/pages/docs/package-repositories.md b/pages/docs/package-repositories.md deleted file mode 100644 index 5e42312..0000000 --- a/pages/docs/package-repositories.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Package Repositories -description: Veilid has Rust, Python, Debian, and Fedora packages available. -weight: 6 -layout: subpage ---- - -To run a "headless" Veilid node, you can install `veilid-server` and `veilid-cli` from repositories. - -- [Debian](/docs/debian-install/) -- [Fedora](http://localhost:8000/docs/fedora-install/) -- [PyPi](https://pypi.org/project/veilid/) diff --git a/pages/framework/private-routing.md b/pages/docs/private-routing.md similarity index 99% rename from pages/framework/private-routing.md rename to pages/docs/private-routing.md index 9cf739b..76d834c 100644 --- a/pages/framework/private-routing.md +++ b/pages/docs/private-routing.md @@ -1,7 +1,7 @@ --- title: Private Routing description: An overview of how private routing works in Veilid -weight: 5 +weight: 25 layout: subpage --- diff --git a/pages/framework/rpc.md b/pages/docs/rpc.md similarity index 99% rename from pages/framework/rpc.md rename to pages/docs/rpc.md index 14b5fc2..8fb5bea 100644 --- a/pages/framework/rpc.md +++ b/pages/docs/rpc.md @@ -1,7 +1,7 @@ --- title: RPC Protocol description: An overview of the RPC protocol used in Veilid -weight: 4 +weight: 24 layout: subpage --- diff --git a/pages/docs/code-repositories.md b/pages/download.md similarity index 78% rename from pages/docs/code-repositories.md rename to pages/download.md index e6dedb5..02b31a3 100644 --- a/pages/docs/code-repositories.md +++ b/pages/download.md @@ -1,13 +1,13 @@ --- -title: Code Repositories +title: Download description: The code base for the different parts and tools of Veilid -weight: 2 -layout: subpage +menu: + main: + weight: 2 +layout: index --- -### Veilid Framework - -#### Getting Started +### Getting Started Please recursively check out the project using this command @@ -15,7 +15,7 @@ Please recursively check out the project using this command Then read the [development](https://gitlab.com/veilid/veilid/-/blob/main/DEVELOPMENT.md) guide to get started. -#### About the Code Repo +### About the Code Repo The main repository is located at https://gitlab.com/veilid/veilid and includes several components - `veilid-core` - the main Veilid crate: https://crates.io/crates/veilid-core @@ -23,7 +23,3 @@ The main repository is located at https://gitlab.com/veilid/veilid and includes - `veilid-wasm` - Veilid bindings for webassembly: https://crates.io/crates/veilid-wasm - `veilid-flutter` - Veilid bindings for Flutter/Dart. Comes with an example program: https://crates.io/crates/veilid-flutter - Also `veilid-server` and `veilid-cli` source are also in this repo for building headless nodes - -### VeilidChat - -The code for VeilidChat will be available at https://gitlab.com/veilid/veilidchat once we're recovered from DefCon.