Skip to content

Commit b8df4d6

Browse files
authored
docs: fix link and trim (oxia-db#319)
Signed-off-by: tison <[email protected]>
1 parent c0b4c32 commit b8df4d6

File tree

2 files changed

+26
-29
lines changed

2 files changed

+26
-29
lines changed

README.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,37 @@
22

33
[![Build](https://github.com/streamnative/oxia/actions/workflows/pr_build_and_test.yaml/badge.svg)](https://github.com/streamnative/oxia/actions/workflows/pr_build_and_test.yaml)
44

5-
65
Oxia is a scalable metadata store and coordination system that can be used as the core infrastructure to build
76
large scale distributed systems.
87

98
## Why Oxia?
109

11-
* Design optimized for Kubernetes environment
12-
* Transparent horizontal scalability
13-
* Linearizable per-key operations
14-
* Able to sustain millions of read/write per second
15-
* Able to store 100s of GBs
10+
* Design optimized for Kubernetes environment
11+
* Transparent horizontal scalability
12+
* Linearizable per-key operations
13+
* Able to sustain millions of read/write per second
14+
* Able to store 100s of GBs
1615

1716
## Features
1817

19-
* Key-Value interface
20-
* Notification mechanism
21-
* Ephemeral records
22-
* Automated session management
18+
* Key-Value interface
19+
* Notification mechanism
20+
* Ephemeral records
21+
* Automated session management
2322

2423
## Documentation
25-
* [Design goals](docs/design-goals.md)
26-
* [Architecture](docs/architecture.md)
27-
* [Getting started with Oxia](docs/getting-started.md)
28-
* [Go client API](docs/go-api.md)
29-
* [Deploy using K8S operator](docs/ks8-operator.md)
30-
* Developer docs
31-
* [Replication protocol](docs/replication-protocol.md)
32-
- [Coordinator](docs/replication-coordinator.md)
33-
- [Storage](docs/replication-storage.md)
34-
* [Verifying correctness](docs/correctness.md)
35-
* [Oxia's K8S resources](docs/kubernetes-oxia-cluster.md)
24+
25+
* [Design goals](docs/design-goals.md)
26+
* [Architecture](docs/architecture.md)
27+
* [Getting started with Oxia](docs/getting-started.md)
28+
* [Go client API](docs/go-api.md)
29+
* [Deploy using K8S operator](docs/ks8-operator.md)
30+
* Developer docs
31+
* [Replication protocol](docs/replication-protocol.md)
32+
* [Coordinator](docs/replication-coordinator.md)
33+
* [Storage](docs/replication-storage.md)
34+
* [Verifying correctness](docs/correctness.md)
35+
* [Oxia's K8S resources](docs/kubernetes-oxia-cluster.md)
3636

3737
## License
3838

docs/ks8-operator.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
2-
# Deploying in Kubernetes with Oxia operator
3-
1+
# Deploying in Kubernetes with Oxia operator
42

53
## Monitoring Oxia
64

@@ -12,8 +10,8 @@ The Helm chart for the controller and the Oxia operator both use a `monitoringEn
1210
install the service monitor. If you don't have Prometheus installed and don't want to install it, you can set
1311
`monitoringEnabled: false` to skip this part.
1412

15-
Grafana's dashboards are available at [../deploy/dashboards](). These can just be imported in your existing Grafana
16-
instance.
13+
Grafana's dashboards are available at [deploy/dashboards](/deploy/dashboards).
14+
These can just be imported in your existing Grafana instance.
1715

1816
### Deploying Prometheus Stack
1917

@@ -33,7 +31,6 @@ $ helm repo update
3331
This installs the stock Prometheus & Grafana, without the Oxia dashboards, which you will be able to manually
3432
import later.
3533

36-
3734
```shell
3835
$ helm install monitoring prometheus-community/kube-prometheus-stack \
3936
--namespace monitoring \
@@ -82,9 +79,9 @@ $ helm upgrade --install oxia-controller \
8279

8380
Now that the Oxia controller is running, we can create K8S resources of type `OxiaCluster`, by submitting a CRD.
8481

85-
An example of CRD can be found at [example-oxia-cluster.yaml](../deploy/examples/example-oxia-cluster.yaml).
82+
An example of CRD can be found at [example-oxia-cluster.yaml](/deploy/examples/example-oxia-cluster.yaml).
8683

87-
The full specification of the CRD is at [oxiaclusters.yaml](../deploy/crds/oxiaclusters.yaml).
84+
The full specification of the CRD is at [oxiaclusters.yaml](/deploy/crds/oxiaclusters.yaml).
8885

8986
A minimal example of CRD is:
9087

0 commit comments

Comments
 (0)