publicdata/j40-cejst-2
1
0
Fork 0
mirror of https://github.com/DOI-DO/j40-cejst-2.git synced 2025-02-22 09:41:26 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions
j40-cejst-2/docs/INDEX.md
Neil Martinsen-Burrell 1b241a6587 Documentation updates and an index of the documentation
2025-01-16 14:11:17 -06:00

3.1 KiB
Raw Blame History

Documentation index

There is lots of existing documentation in this repository and this file attempts to index it along with light annotations.

Top-level

  • README.md: The top-level README file, mostly pointers to other documentation files for particular tasks
  • QUICKSTART.md: Instructions for quickly running the site locally using Docker
  • CONTRIBUTING.md, COMMUNITY_GUIDLEINES.md, CODE_OF_CONDUCT.md: Guidelines for participation in this product and community
  • DATASETS.md: Comprehensive documentation of all the data that is incorporated into CEJST. The actual data processing is in the data/data-pipeline directory, but this documentation should be kept up to date with the code there
  • INSTALLATION.md: A more developer-focused set of instructions for installing dependencies to be able to make changes to the site

Documentation

  • Glossary: A glossary of terms used on the project
  • Operations: Files documenting the operation of the site, including artifacts, version rollbacks, and deployment
  • architecture/README.md: General description of the technical architecture of the site
  • Decisions: This project uses Architecture Decision Records (ADRs) to document technical decisions as they are made

Client

  • README.md: Instructions for installing dependencies and running the front-end website. Very detailed, the first starting point for web developers.
  • VIEW_MAP_DATA.md: Detailed instructions for inspecting how the application records and displays the map data
  • DESIGN2DEV.md: Outdated Documents how visual designers and developers can work together. Some details on how the site handles styling.

Data pipeline

  • README.md: Very detailed description of the backend data process, including installation, running, and testing. The first starting point for backend data developers.
  • INSTALLATION.md: Detailed instructions on installing the dependencies for developing on the data pipeline.
  • Comparison tool: Information about a tool for comparing CEJST scores using parametrized Jupyter notebooks
  • Adding a variable: Instructions for adding a new variable to the CEJST score

Github Workflows

  • README.md: Details about the Github Actions workflows for testing and deploying the application
  • INFRASTRUCTURE.md: Details about the infrastructure that the site runs on
  • ENVIRONMENT_VARIABLES.md: Details about the environment variable configuration and the secrets for deploying the site