Skip to content

docs navigation #40

@minrk

Description

@minrk

While we have a large amount of general docs we'd like to exist and what kind of thing they are in #39, that doesn't dictate the navigation. We expect a variety of audiences with very different, and the docs should. These can be in the form of landing pages, index pages, etc.

The main thing to think about is:

  • which audiences to consider
  • what docs are relevant to them
  • and in what order to present them

Example audiences and some of the planned docs they would be interested in:

  • decision makers:
    • security
    • resource requirements
  • deployers:
    • deployment docs
    • security and access control
    • docs relevant to exchange deployment
  • end users / practitioners:
    • data structures, apis
    • sample data fetching/visualization tutorials
    • exchange UI, user management

We could for example have a /welcome/deployer.md that presents JupyterHealth to current and/or prospective deployers and similar for other audiences.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions