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.

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

Improve deployment docs tutorials to get to production ready setup #230

Open
4 tasks
surchs opened this issue Jan 15, 2025 · 0 comments
Open
4 tasks

Improve deployment docs tutorials to get to production ready setup #230

surchs opened this issue Jan 15, 2025 · 0 comments
Labels
Milestone Used to track other issues that are required to complete the milestone.

Comments

@surchs
Copy link
Contributor

surchs commented Jan 15, 2025

Context

We have pretty good docs on how to get started with deployment but there is always a balancing act between making the getting started section very quick and simple, and giving users all the relevant information so they can make good decisions for their production deployments. This has now come up twice (most recently in neurobagel/documentation#261) so it would be good to review this section

Why

  • Have the best deployment onboarding docs we can
  • Make sure both interested and convinced users have a good deployment experience
  • Help users set up robust production deployments of their nodes
  • Figure out how users consume our docs to inform decisions (measure / ask and listen)

Outcomes

  • We have a couple of past and prospective deployment users we ask about their initial setup experience with our docs
  • We have a plan for how to continue learning / monitoring how people user our docs and what they find easy or hard (e.g. survey?)
  • We have written down our view as a team on what the goal of the starting docs are (e.g. including some principles)
  • We have a decision on what updates/refactors we want to make to the getting started docs

What

  • [ ]
@surchs surchs added the Milestone Used to track other issues that are required to complete the milestone. label Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Milestone Used to track other issues that are required to complete the milestone.
Projects
Status: No status
Development

No branches or pull requests

1 participant