From 0c672e11206a6cf9e1d4fdb39a0ceb3d195d87cc Mon Sep 17 00:00:00 2001 From: Alice Rhodes Date: Sun, 20 Aug 2023 17:35:06 -0400 Subject: [PATCH] Starting to fill out the server & cli install instructions more --- pages/docs/accessibility.md | 2 +- pages/docs/code-repositories.md | 6 --- pages/docs/debian-install.md | 76 +++++++++++++++--------------- pages/docs/fedora-install.md | 68 +++++--------------------- pages/docs/package-repositories.md | 43 ++--------------- 5 files changed, 56 insertions(+), 139 deletions(-) diff --git a/pages/docs/accessibility.md b/pages/docs/accessibility.md index 0dea5b6..568f00a 100644 --- a/pages/docs/accessibility.md +++ b/pages/docs/accessibility.md @@ -1,7 +1,7 @@ --- title: Accessibility Guidance description: An introduction to accessibility concepts -weight: 4 +weight: 7 layout: subpage --- diff --git a/pages/docs/code-repositories.md b/pages/docs/code-repositories.md index 418017c..e6dedb5 100644 --- a/pages/docs/code-repositories.md +++ b/pages/docs/code-repositories.md @@ -24,12 +24,6 @@ The main repository is located at https://gitlab.com/veilid/veilid and includes - `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 - -### Packages - -If you want to install `veilid-server` and `veilid-cli` from package repositories, -please refer to our [instructions](https://gitlab.com/veilid/veilid/-/blob/main/INSTALL.md). - ### VeilidChat The code for VeilidChat will be available at https://gitlab.com/veilid/veilidchat once we're recovered from DefCon. diff --git a/pages/docs/debian-install.md b/pages/docs/debian-install.md index 0dea5b6..4bd6430 100644 --- a/pages/docs/debian-install.md +++ b/pages/docs/debian-install.md @@ -1,62 +1,64 @@ --- -title: Accessibility Guidance -description: An introduction to accessibility concepts -weight: 4 +title: Debian Install +description: How to install `veilid-server` and `veilid-cli` on Debian based systems +weight: 3 layout: subpage --- +### Step 1 -### General Accessibility Concepts +Get the keys for package repo -For the scope of this document, we are referring to the accessibility of websites, documents, and applications. +
+ + +
-### Types of Accessibility Challenges +### Step 2 -Here is a partial list of capabilities to keep in mind when designing: +Add the repo to apt -**Fine Motor Control** – The dexterity of one's eyes, hands, and fingers for the ability to examine and manipulate objects. In practical terms, is it easy for someone using a touch screen to easily click interactive elements and can folks with fine motor control issues manage to interact with those elements was well. +
+ + +
-**Sightedness** – Levels of blindness, near sightedness, and far sightedness. Low-vision users tend to need high color contrast and larger sized text and elements. +### Step 3 -**Color Vision** – Color blindness changes how people perceive colors which can reduce color contrast and make differentiating color coded items difficult. +Update your system -**Cognitive Capabilities** – Memory, train of thought, following instructions, and judgment are cognitive capabilities that most folks take for granted. Various disabilities can affect these as well as situational conditions such as being tired from working late. +
+ + +
-**Hearing** – Hearing difficulties can make audio cues or videos less effective. +### Step 4 -### Accessibility Guidelines +Install `veilid-server` and `veilid-cli` -Here is a partial list of general accessibility goals you should strive for: +
+ + +
-#### Structure +### Step 5 -- Headers are marked denoted at headers in the mark-up or code -- Sections of a page or screen are visually distinct and easy to identify +Start `veilid-server.service` manually -#### Navigation +
+ + +
-- Easy to figure out current location -- Easy to figure out where you can go -- Consistent navigation structures and styling +### Step 6 -#### Interactions +Set up `veilid-server.service` to start at boot -- Clickable items are styled consistently as clickable -- Clickable items have a generous hit-box size -- UI elements can be easily manipulated with assistive technology +
+ + +
-#### Typography -- Adjustable text size -- Adjusting the text size does not breaking the layout or usability -- Text customization options such as changing fonts -#### Colors -- Good color contrast for text to be readable -- Use a secondary indicator (shape, size, pattern, etc) rather than color alone - -#### Video - -- For the audio in videos, provide subtitles of the dialog and sounds -- A transcript of all the content conveyed in the video helps a wide audiences \ No newline at end of file diff --git a/pages/docs/fedora-install.md b/pages/docs/fedora-install.md index 802b807..e403613 100644 --- a/pages/docs/fedora-install.md +++ b/pages/docs/fedora-install.md @@ -1,62 +1,18 @@ --- -title: Debian Install -description: How to install `veilid-server` and `veilid-cli` on Debian based systems -weight: 3 +title: Fedora Install +description: How to install `veilid-server` and `veilid-cli` on Fedora based systems +weight: 4 layout: subpage --- +

Fedora Based Systems

-### General Accessibility Concepts +
+ + +
-For the scope of this document, we are referring to the accessibility of websites, documents, and applications. - -### Types of Accessibility Challenges - -Here is a partial list of capabilities to keep in mind when designing: - -**Fine Motor Control** – The dexterity of one's eyes, hands, and fingers for the ability to examine and manipulate objects. In practical terms, is it easy for someone using a touch screen to easily click interactive elements and can folks with fine motor control issues manage to interact with those elements was well. - -**Sightedness** – Levels of blindness, near sightedness, and far sightedness. Low-vision users tend to need high color contrast and larger sized text and elements. - -**Color Vision** – Color blindness changes how people perceive colors which can reduce color contrast and make differentiating color coded items difficult. - -**Cognitive Capabilities** – Memory, train of thought, following instructions, and judgment are cognitive capabilities that most folks take for granted. Various disabilities can affect these as well as situational conditions such as being tired from working late. - -**Hearing** – Hearing difficulties can make audio cues or videos less effective. - -### Accessibility Guidelines - -Here is a partial list of general accessibility goals you should strive for: - -#### Structure - -- Headers are marked denoted at headers in the mark-up or code -- Sections of a page or screen are visually distinct and easy to identify - -#### Navigation - -- Easy to figure out current location -- Easy to figure out where you can go -- Consistent navigation structures and styling - -#### Interactions - -- Clickable items are styled consistently as clickable -- Clickable items have a generous hit-box size -- UI elements can be easily manipulated with assistive technology - -#### Typography - -- Adjustable text size -- Adjusting the text size does not breaking the layout or usability -- Text customization options such as changing fonts - -#### Colors - -- Good color contrast for text to be readable -- Use a secondary indicator (shape, size, pattern, etc) rather than color alone - -#### Video - -- For the audio in videos, provide subtitles of the dialog and sounds -- A transcript of all the content conveyed in the video helps a wide audiences \ No newline at end of file +
+ + +
\ No newline at end of file diff --git a/pages/docs/package-repositories.md b/pages/docs/package-repositories.md index 60a095f..5e42312 100644 --- a/pages/docs/package-repositories.md +++ b/pages/docs/package-repositories.md @@ -1,47 +1,12 @@ --- title: Package Repositories description: Veilid has Rust, Python, Debian, and Fedora packages available. -weight: 3 +weight: 6 layout: subpage --- To run a "headless" Veilid node, you can install `veilid-server` and `veilid-cli` from repositories. -

Debian Based Systems

- -
- - -
- -

Note: The key's fingerprint is 516C76D1E372C5C96EE54E22AE0E059BC64CD052

- -
- - -
- -
- - -
- -
- - -
- - -

Fedora Based Systems

- -
- - -
-
- - -
- -

PyPi

-

https://pypi.org/project/veilid/

+- [Debian](/docs/debian-install/) +- [Fedora](http://localhost:8000/docs/fedora-install/) +- [PyPi](https://pypi.org/project/veilid/)