Skip to content

Idea: Expand docs site to include knowledge base #329

@BSick7

Description

@BSick7

Our docs site was a great first pass at helping users with the system.
However, it could be improved, specifically to provide quickstarts and educational paths.

There are several tiers of "getting started" how-to guides that would be helpful:

  • Setup: (Install CLI, Connect to cloud providers, Run terraform locally)
  • Create app: (our current quickstarts)
  • Configure core infra: (Set up VPN, set up bastion, configure logging/telemetry)
  • How to debug/diagnose: (SSH into box, connect to database, find something in logs)

As I'm writing this, it also occurs to me that many of these guides could be incorporated into the product itself.
Many guides are context-specific and don't rely on a user to go find them in the docs. Instead, they're right next to the "thing" they're trying to operate.

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