Move docs to follow Diátaxis - Githubissues

clusterinthecloud / docs

A tutorial to set up a running compute cluster on cloud resources

https://cluster-in-the-cloud.readthedocs.io/en/latest/

Other

9 stars 8 forks source link

Move docs to follow Diátaxis #20

Open milliams opened 3 years ago

milliams commented 3 years ago

Following https://diataxis.fr we could reorganise the docs to split them into tutorials, how-tos and explanation. There's not much of a place for "reference" in CitC I think though.

The reorganisation could look like:

Tutorials
- Installing a cluster
- Running your first job
- Deleting a cluster
How-tos
- Setting up ARM nodes on AWS
- Setting up GPU nodes
- Installing and managing software
- Updating CitC
Explanation
- How the elastic scaling works
- Why are nodes managed by name in the way they are

etc.

milliams commented 3 years ago

This is now on the way. I will leave this issue open until the conversion is complete.