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
This commit is contained in:
Alice Rhodes 2023-08-23 12:24:30 -04:00
parent f4683ded96
commit 604f55ccec
11 changed files with 18 additions and 163 deletions

View File

@ -1,7 +1,7 @@
--- ---
title: Accessibility title: Accessibility
description: An introduction to accessibility concepts and resources description: An introduction to accessibility concepts and resources
weight: 7 weight: 30
layout: subpage layout: subpage
--- ---

View File

@ -1,7 +1,7 @@
--- ---
title: Cryptography title: Cryptography
description: An overview of the cryptography used in Veilid description: An overview of the cryptography used in Veilid
weight: 3 weight: 23
layout: subpage layout: subpage
--- ---

View File

@ -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.
<div class="code-snippet">
<input aria-label="Get Keys" type="text" readonly value="wget -O- https://packages.veilid.net/gpg/veilid-packages-key.public | sudo gpg --dearmor -o /usr/share/keyrings/veilid-packages-keyring.gpg">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
### Step 2
Identify your architecture
_Explanation_: The following command will tell you what type of CPU your system is running
<div class="code-snippet">
<input aria-label="Add Keys" type="text" readonly value='dpkg --print-architecture'>
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
### 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:
<div class="code-snippet">
<input aria-label="Add Keys" type="text" readonly value='echo "deb [arch=amd64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" | sudo tee /etc/apt/sources.list.d/veilid.list 1>/dev/null'>
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
- For **ARM**64 based systems run this command:
<div class="code-snippet">
<input aria-label="Add Keys" type="text" readonly value='echo "deb [arch=arm64 signed-by=/usr/share/keyrings/veilid-packages-keyring.gpg] https://packages.veilid.net/apt stable main" | sudo tee /etc/apt/sources.list.d/veilid.list 1>/dev/null'>
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
_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
<div class="code-snippet">
<input aria-label="Run Updates" type="text" readonly value="apt update">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
#### Step 5
Install Veilid.
_Explanation_: With the package manager updated, it is now possible to install Veilid!
<div class="code-snippet">
<input aria-label="Install the headless and command line utilities" type="text" readonly value="apt install veilid-server veilid-cli">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
<hr />
The remaining steps are optional.
### Step 6
Start `veilid-server.service` manually
<div class="code-snippet">
<input aria-label="Install the headless and command line utilities" type="text" readonly value="sudo systemctl start veilid-server.service">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
### Step 7
Set up `veilid-server.service` to start at boot
<div class="code-snippet">
<input aria-label="Install the headless and command line utilities" type="text" readonly value="sudo systemctl enable --now veilid-server.service">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>

View File

@ -1,18 +0,0 @@
---
title: Fedora Install
description: How to install `veilid-server` and `veilid-cli` on Fedora based systems
weight: 4
layout: subpage
---
<h3>Fedora Based Systems</h3>
<div class="code-snippet">
<input aria-label="Add repo" type="text" readonly value="yum-config-manager --add-repo https://packages.veilid.net/rpm/veilid-rpm-repo.repo">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>
<div class="code-snippet">
<input aria-label="Install the headless and command line utilities" type="text" readonly value="dnf install veilid-server veilid-cli">
<button class="btn btn-secondary"><span>Copy</span></button>
</div>

View File

@ -12,20 +12,10 @@ The documentation is currently a work in progress.
Are you good at writing? <a href="/about-us/community/">We could use your help</a>. Are you good at writing? <a href="/about-us/community/">We could use your help</a>.
### Available Documentation ### Documentation Week
- Slides from DefCon: [Download PDF](/Launch-Slides-Veilid.pdf) 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.
- [Checkout the Code](/docs/code-repositories/)
- [Install from Packages](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md)
We're looking to the community to help write out additional documentation, tutorials, and guides.
<!-- Check out the #documentation channel on our [Discord server](/discord).
Here's what we've got so far:
- [Rust documentation](https://docs.rs/releases/search?query=veilid)
-->

View File

@ -1,7 +1,7 @@
--- ---
title: Networking title: Networking
description: An overview of the networking used in Veilid description: An overview of the networking used in Veilid
weight: 2 weight: 22
layout: subpage layout: subpage
--- ---

View File

@ -1,10 +1,7 @@
--- ---
title: Framework title: Framework Overview
description: An overview of the Veilid Framework description: An overview of the Veilid Framework
menu: weight: 20
main:
weight: 3
weight: 1
layout: subpage layout: subpage
sortby: weight sortby: weight
--- ---

View File

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

View File

@ -1,7 +1,7 @@
--- ---
title: Private Routing title: Private Routing
description: An overview of how private routing works in Veilid description: An overview of how private routing works in Veilid
weight: 5 weight: 25
layout: subpage layout: subpage
--- ---

View File

@ -1,7 +1,7 @@
--- ---
title: RPC Protocol title: RPC Protocol
description: An overview of the RPC protocol used in Veilid description: An overview of the RPC protocol used in Veilid
weight: 4 weight: 24
layout: subpage layout: subpage
--- ---

View File

@ -1,13 +1,13 @@
--- ---
title: Code Repositories title: Download
description: The code base for the different parts and tools of Veilid description: The code base for the different parts and tools of Veilid
weight: 2 menu:
layout: subpage main:
weight: 2
layout: index
--- ---
### Veilid Framework ### Getting Started
#### Getting Started
Please recursively check out the project using this command 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. 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 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 - `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-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 - `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 - 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.