Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Move docs to follow Diátaxis #20

Open
milliams opened this issue Jul 22, 2021 · 1 comment
Open

Move docs to follow Diátaxis #20

milliams opened this issue Jul 22, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@milliams
Copy link
Member

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 milliams added the enhancement New feature or request label Jul 22, 2021
@milliams
Copy link
Member Author

milliams commented Aug 5, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@milliams