search

chanzuckerberg / cellxgene-census

CZ CELLxGENE Discover Census
https://chanzuckerberg.github.io/cellxgene-census/
MIT License
72 stars 19 forks source link

Add documentation to aid the developer on development and operations for census builder and api #1109

Open prathapsridharan opened 2 months ago

prathapsridharan commented 2 months ago

The documentation a developer needs to develop, run, test, and release census api and census builder is not easily accessible and up-to-date. Some things a new developer needs to easily find documentation for:

  1. How do I install my development environment?
  2. How do I run the application locally?
  3. What are the cloud environments, accounts, and services in use when the system is operating? How do I access them?
  4. Where are the logs?
  5. What is the release cadence? How is it done?
  6. What are some procedures to follow when a production problem is encountered - a basic runbook?

This improvement in developer documentation can be done incrementally