Skip to content

Reassess method of linking follow-up material at end of docs pages #81

@dsloanm

Description

@dsloanm

Opening this following discussion with @AshleyCliff and @NucciTheBoss.

We currently have "Next Steps" sections in the COS how-to and the deploy Slurm how-to which link to the next how-to we expect the user to proceed to. Rather than "Next Steps", we may want to take inspiration from the "Related topics" section in the Microcloud docs.

We could then link related sections of our documentation without prescribing a fixed sequence for the how-tos. We could still use logical subsections for the how-tos ("Setup", "Manage", etc.) and use the "Next" and "Previous" buttons at the end of each page for a suggested follow-up how-to, where this makes sense, but we would be more open to linking to, e.g., Explanation pages, Reference pages, or external documentation.

Once the tutorial in #80 is merged, we should reassess our docs "flow" in general to ensure we're directing people reasonably through the sections.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions