Skip to content

Instantly share code, notes, and snippets.

@sploiselle
Last active November 20, 2018 20:21
Show Gist options
  • Save sploiselle/27c42611597ff919a146748d15d7ff64 to your computer and use it in GitHub Desktop.
Save sploiselle/27c42611597ff919a146748d15d7ff64 to your computer and use it in GitHub Desktop.

In attendance: Amruta, Lauren, Sean

Problem

Lots of negative votes on current docs home page

Solution

Workflow-topic based content - Fulfill user's intent "ISBAT" - Focusing on workflows gives us a new way to organize information that currently DNE - Create new overview pages for each workflow to give us a chance to help scaffold user's experience/understanding of product area

Strawman/v0 Implementation

Collapsable tiles that hide/show links

6 tiles with content 4 links 1 overview 3 add'l links

  1. Get Started [Sean]

    • What is CockroachDB? (Overview)
    • Install CockroachDB
    • Start a Cluster
    • Build an app
  2. SQL [Rich]

    • SQL Statements
    • Top 3 SQL statement pages
  3. Migrate to CockroachDB [Lauren]

    • Migration Overview
    • Import
    • Import
    • Import
  4. Deployments [Lauren]

    • Deployment Overview
    • AWS
    • Production Checklist
    • Kubernetes
  5. Troubleshooting [Amruta]

    • Troubleshooting Overview
    • SQL Troubleshooting
    • Deployment Troubleshooting
    • Security Troubleshooting
  6. Security [Amruta]

    • Security Overview
    • Certificates
    • Users
    • Encryption at Rest

Timeline

We need to generate the overview pages we've identified before. This isn't a lot of content, but it isn't on the roadmap. Maybe by EOQ? If not, can tackle in Q1.

Additional work:

  • Expanding side nav by default on home page?
  • Control F through all docs content (M-sized dev work)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment