-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
18 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,3 @@ | ||
book | ||
.vscode | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,19 @@ | ||
# ADN Documentation | ||
# AppNet Documentation | ||
|
||
## Quick Start | ||
1. Install mdbook: | ||
``` | ||
```bash | ||
# You need to install Rust first | ||
cargo install mdbook | ||
``` | ||
|
||
2. Work on your documentation while having an http server for it on | ||
localhost:3000, rebuilding on change. | ||
``` | ||
```bash | ||
mdbook serve | ||
``` | ||
|
||
<!-- 3. Build the book and open a browser to view the result: | ||
3. Build the book and open a browser to view the result: | ||
``` | ||
mdbook build -o | ||
``` --> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,25 @@ | ||
# Installation Guide | ||
|
||
Welcome to the ADN installation guide. This document provides step-by-step instructions on how to set up ADN and its dependencies. | ||
Welcome to the AppNet installation guide. This document provides step-by-step instructions on how to set up AppNet and its dependencies. | ||
|
||
Requirements: | ||
- [Kubernetes](#kubernetes) (v1.28+) | ||
- [Istio](#installing-adnistio) (v1.20+) | ||
- [Istio](#istio) (v1.20+) | ||
- [Python](#python) (v3.10+) | ||
- [Go](#go) (v1.19+) | ||
- [Rust](#rust) (v1.71+) | ||
- [protoc](#protoc) | ||
|
||
|
||
First, clone the ADN repo: | ||
First, clone the AppNet repo: | ||
```bash | ||
git clone [email protected]:UWNetworksLab/adn-controller.git | ||
cd adn-controller | ||
git clone [email protected]:appnet-org/controller.git --recursive | ||
cd controller | ||
``` | ||
|
||
### Install the CLI | ||
|
||
`adnctl` is a command line program to manage the ADN control plane. | ||
`adnctl` is a command line program to manage the AppNet control plane. | ||
|
||
To install the CLI, run | ||
```bash | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters