Skip to content

Move docs to follow Diátaxis #20

Open
@milliams

Description

@milliams

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions