Skip to content

Commit ab93f24

Browse files
committed
DOC: Split docs into three main sections
skipci
1 parent b86c7f5 commit ab93f24

File tree

4 files changed

+13
-9
lines changed

4 files changed

+13
-9
lines changed

docs/creating.md renamed to docs/creating_services/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Before you begin, ensure you:
99
- Are familiar with Python and the command line
1010
- Have the following tools installed:
1111
- Python >= 3.10
12-
- The `octue` python library / CLI (see [installation instructions](installation.md))
12+
- The `octue` python library / CLI (see [installation instructions](../installation.md))
1313

1414
<!-- prettier-ignore-end -->

docs/infrastructure.md renamed to docs/managing_infrastructure/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ Follow the instructions [here](https://github.com/octue/terraform-octue-twined-c
2727

2828
## Next steps
2929

30-
Congratulations on setting up a Twined services network! Next up, [create your first data service](creating.md).
30+
Congratulations on setting up a Twined services network! Next up, [create your first data service](../creating_services/getting_started.md).

docs/getting_started.md renamed to docs/using_services/getting_started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Before you begin, ensure you:
1717
- Are familiar with Python and/or the command line
1818
- Have the following tools installed:
1919
- Python >= 3.10
20-
- The `octue` python library / CLI (see [installation instructions](installation.md))
20+
- The `octue` python library / CLI (see [installation instructions](../installation.md))
2121

2222
<!-- prettier-ignore-end -->
2323

@@ -123,8 +123,8 @@ The following command asks a question to the local example data service.
123123

124124
Congratulations on running your first analysis! For additional information, check out the following resources:
125125

126-
- [Set up infrastructure for a data service(s) using Terraform](infrastructure.md)
127-
- [Create a data service](creating.md)
126+
- [Set up infrastructure for a data service(s) using Terraform](../managing_infrastructure/getting_started.md)
127+
- [Create a data service](../creating_services/getting_started.md)
128128
- Run a data service locally
129129
- See the library and CLI reference
130-
- [Get support](support.md)
130+
- [Get support](../support.md)

mkdocs.yml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@ site_url: https://twined.octue.com
44
nav:
55
- Overview: index.md
66
- installation.md
7-
- Setting up infrastructure: infrastructure.md
8-
- Creating a service: creating.md
7+
- Using services:
8+
- using_services/getting_started.md
9+
- Creating services:
10+
- creating_services/getting_started.md
11+
- Managing infrastructure:
12+
- managing_infrastructure/getting_started.md
13+
- glossary.md
914
- license.md
1015
- version_history.md
1116
- support.md
12-
- glossary.md
1317

1418
theme:
1519
name: material

0 commit comments

Comments
 (0)