Skip to content

Commit 925452e

Browse files
committed
Setup index in markdonw
1 parent 7d78422 commit 925452e

File tree

3 files changed

+14
-22
lines changed

3 files changed

+14
-22
lines changed

observability/docs/get-started/quickstart.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
## QuickStart
1+
# QuickStart
22

33
This tutorial guides you through running the simplest setup of the observability stack using example configuration files and Docker Compose.
44

55
After completing these steps, you will have a full observability stack running locally, showing the availability of web pages you want to target
66

7-
### Requirements
7+
## Requirements
88

99
- Docker installed ([install Docker](https://docs.docker.com/get-docker/))
1010
- Docker Compose installed ([install Docker Compose](https://docs.docker.com/compose/install/))
1111
- A terminal with network access
1212

13+
## Steps
14+
1315
### Step 1: Run the Quickstart script
1416

1517
Run this quickstart script to setup the project

observability/docs/main.md renamed to observability/docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# Cogstack Observability Stack
23

34
This project provides observability of a cogstack deployment.
@@ -14,5 +15,14 @@ It provides the following features:
1415
See the [Quickstart](./get-started/quickstart.md) to see how to easily run this stack.
1516

1617

18+
```{toctree}
19+
:maxdepth: 2
20+
get-started/quickstart.md
21+
get-started/userguide-tutorial.md
22+
```
1723

24+
## Indices and tables
1825

26+
* :ref:`genindex`
27+
* :ref:`modindex`
28+
* :ref:`search`

observability/docs/index.rst

Lines changed: 0 additions & 20 deletions
This file was deleted.

0 commit comments

Comments
 (0)