Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update quickstart in the doc #174

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,13 @@ kubectl create -k config/dependency
kubectl apply -k config/default
```

Install stable distribution
```shell
# Note: this command will be available after the repo going public

# Install component dependencies
kubectl create -k "github.com/aibrix/aibrix/config/dependency"
kubectl create -k "github.com/aibrix/aibrix/config/dependency?ref=v0.1.0-rc.1"

# Install aibrix components
kubectl apply -k "github.com/aibrix/aibrix/config/default"
kubectl apply -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"
```

## Documentation
Expand Down
26 changes: 25 additions & 1 deletion docs/source/getting_started/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,28 @@
Quickstart
==========

This section contains how to do a quickstart.

To get started with AIBrix, clone `aibrix/aibrix` repository, and install the manifests.
.. note::
This is the latest version which is not very stable, take your risk.

.. code:: bash
# Local Testing
git clone https://github.com/aibrix/aibrix.git
cd aibrix

# Install component dependencies
kubectl create -k config/dependency

# Install aibrix components
kubectl apply -k config/default


Install stable distribution.

.. code:: bash
# Install component dependencies
kubectl create -k "github.com/aibrix/aibrix/config/dependency?ref=v0.1.0-rc.1"

# Install aibrix components
kubectl apply -k "github.com/aibrix/aibrix/config/default?ref=v0.1.0-rc.1"
Loading