mirror of
https://github.com/DOI-DO/j40-cejst-2.git
synced 2025-02-20 08:41:26 -08:00
Documentation updates and an index of the documentation
This commit is contained in:
Neil Martinsen-Burrell
parent
53aa46f543
commit
1b241a6587
7 changed files with 50 additions and 15 deletions
2
.github/workflows/README.md
vendored
2
.github/workflows/README.md
vendored
|
|
@ -25,8 +25,6 @@ Builds and deploys the backend data pipeline to AWS. This workflow is set to be
|
|||
### Deploy Frontend Main
|
||||
Builds and deploys the frontend web client to AWS when changes to the ./client directory are merged into main.
|
||||
|
||||
### pages-build-deployment
|
||||
|
||||
### Ping Check
|
||||
Runs a check on the J40 website checking for a return of status 200
|
||||
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Si cree que encontró un error en la herramienta Justice40, consulte nuestra lis
|
|||
|
||||
Cuando informe de un error, siga estas instrucciones:
|
||||
|
||||
- **Use la plantilla de informe de error**, Bug Report ([aquí](https://github.com/usds/justice40-tool/issues/new/choose), para comunicar el problema. La plantilla se llena con la información adecuada.
|
||||
- **Use la plantilla de informe de error**, Bug Report ([aquí](https://github.com/DOI-DO/j40-cejst-2/issues/new/choose), para comunicar el problema. La plantilla se llena con la información adecuada.
|
||||
- **Use un título claro y descriptivo del problema** para definirlo.
|
||||
- **Describa los pasos exactos para reproducir el problema** con todos los detalles posibles. Por ejemplo, comience con una explicación de cómo llegó a la página donde encontró el error.
|
||||
- **Describa el comportamiento que observó después de seguir esos pasos** e indique exactamente cuál es el problema que causa ese comportamiento.
|
||||
|
|
@ -34,7 +34,7 @@ Cuando informe de un error, siga estas instrucciones:
|
|||
|
||||
Si desea sugerir un cambio, solicitar una función o tratar un asunto, pero no tiene el lenguaje o el código específico para enviar su solicitud, puede abrir un problema en este repositorio.
|
||||
|
||||
Abra [aquí](https://github.com/usds/justice40-tool/issues/new/choose) un problema de tipo "Solicitud de función".
|
||||
Abra [aquí](https://github.com/DOI-DO/j40-cejst-2/issues/new/choose) un problema de tipo "Solicitud de función".
|
||||
|
||||
En el problema, describa la función que desea, por qué la necesita y cómo debería funcionar esta. Los integrantes del equipo responderán a este lo antes posible.
|
||||
|
||||
|
|
@ -47,6 +47,6 @@ Si desea colaborar con alguna parte del código base, bifurque el repositorio si
|
|||
<!-- markdown-link-check-disable -->
|
||||
|
||||
- No se permiten las fusiones al proyecto principal `main`; abra una solicitud de incorporación de cambios desde una rama.
|
||||
- Al menos un revisor autorizado debe aprobar la confirmación (en [CODEOWNERS](https://github.com/usds/justice40-tool/tree/main/.github/CODEOWNERS), en inglés, consulte la lista más reciente de estos revisores).
|
||||
- Al menos un revisor autorizado debe aprobar la confirmación (en [CODEOWNERS](https://github.com/DOI-DO/j40-cejst-2/tree/main/.github/CODEOWNERS), en inglés, consulte la lista más reciente de estos revisores).
|
||||
- Todas las verificaciones de estado obligatorias deben ser aprobadas.
|
||||
Si hay un desacuerdo importante entre los integrantes del equipo, se organizará una reunión con el fin de determinar el plan de acción para la solicitud de incorporación de cambios.
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ If you think you have found a bug in the Justice40 tool, search our issues list
|
|||
|
||||
If you do not find your bug in our issues list, file a bug report. When reporting the bug, please follow these guidelines:
|
||||
|
||||
- **Please use the `Bug Report` issue template** ([here](https://github.com/usds/justice40-tool/issues/new/choose)). This is populated with the right information
|
||||
- **Please use the `Bug Report` issue template** ([here](https://github.com/DOI-DO/j40-cejst-2/issues/new/choose)). This is populated with the right information
|
||||
- **Use a clear and descriptive issue title** for the issue to identify the problem.
|
||||
- **Describe the exact steps to reproduce the problem** in as much detail as possible. For example, start by explaining how you got to the page where you encountered the bug.
|
||||
- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
|
||||
|
|
@ -34,7 +34,7 @@ If you do not find your bug in our issues list, file a bug report. When reportin
|
|||
|
||||
If you don't have specific language or code to submit but would like to suggest a change, request a feature, or have something addressed, you can open an issue in this repository.
|
||||
|
||||
Please open an issue of type `Feature request` [here](https://github.com/usds/justice40-tool/issues/new/choose).
|
||||
Please open an issue of type `Feature request` [here](https://github.com/DOI-DO/j40-cejst-2/issues/new/choose).
|
||||
|
||||
In this issue, please describe the feature you would like to see, why you need it, and how it should work. Team members will respond to the Feature request as soon as possible.
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ If you would like to contribute to any part of the codebase, please fork the rep
|
|||
|
||||
- Merges to `main` are prohibited - please open a pull request from a branch
|
||||
- Please create a branch name in the format of `<github-username>`/`<issue-number>`-`<kebab-case-description>`. For example vimusds/1069-fix-territory-on-mobile
|
||||
- At least one required reviewer must approve the commit (see [CODEOWNERS](https://github.com/usds/justice40-tool/tree/main/.github/CODEOWNERS) for the most up-to-date list of these members)
|
||||
- At least one required reviewer must approve the commit (see [CODEOWNERS](https://github.com/DOI-DO/j40-cejst-2/tree/main/.github/CODEOWNERS) for the most up-to-date list of these members)
|
||||
- All required status checks must pass
|
||||
|
||||
If there is significant dissent within the team, a meeting will be held to discuss a plan of action for the pull request.
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Herramienta Justice40
|
||||
|
||||
[](https://github.com/usds/justice40-tool/blob/main/LICENSE.md)
|
||||
[](https://github.com/DOI-DO/j40-cejst-2/blob/main/LICENSE.md)
|
||||
|
||||
_[Read this in English!](README.md)_
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ Le damos la bienvenida a la comunidad de código abierto de Justice40. Este repo
|
|||
|
||||
## Antecedentes
|
||||
|
||||
En enero de 2021, una [orden ejecutiva](https://www.whitehouse.gov/briefing-room/presidential-actions/2021/01/27/executive-order-on-tackling-the-climate-crisis-at-home-and-abroad/) _(en inglés)_ anunció la iniciativa Justice40 y la herramienta de vigilancia con el objetivo de presentar un producto mínimo viable (MVP, por sus siglas en inglés) de la herramienta para el 27 de julio de 2021. La herramienta incluirá mapas interactivos y la versión preliminar de un informe de evaluación para que, al asignar los beneficios de sus programas, las dependencias federales puedan dar prioridad a las comunidades más desatendidas y agobiadas.
|
||||
En enero de 2021, una [orden ejecutiva](https://www.federalregister.gov/documents/2021/02/01/2021-02177/tackling-the-climate-crisis-at-home-and-abroad) _(en inglés)_ anunció la iniciativa Justice40 y la herramienta de vigilancia con el objetivo de presentar un producto mínimo viable (MVP, por sus siglas en inglés) de la herramienta para el 27 de julio de 2021. La herramienta incluirá mapas interactivos y la versión preliminar de un informe de evaluación para que, al asignar los beneficios de sus programas, las dependencias federales puedan dar prioridad a las comunidades más desatendidas y agobiadas.
|
||||
|
||||
## Equipo central
|
||||
|
||||
|
|
@ -53,4 +53,4 @@ La instalación es una instalación típica de gatsby y los detalles se pueden e
|
|||
|
||||
## Comentarios
|
||||
|
||||
Si tiene preguntas o comentarios, escríbanos a justice40open@usds.gov.
|
||||
Si tiene preguntas o comentarios, escríbanos a [justice40-open-source](https://groups.google.com/g/justice40-open-source).
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Justice40 Tool
|
||||
|
||||
[](https://github.com/usds/justice40-tool/blob/main/LICENSE.md)
|
||||
[](https://github.com/DOI-DO/j40-cejst-2/blob/main/LICENSE.md)
|
||||
|
||||
_[¡Lea esto en español!](README-es.md)_
|
||||
|
||||
|
|
@ -8,7 +8,7 @@ This repo contains the code, processes, and documentation for the data and tech
|
|||
|
||||
## Background
|
||||
|
||||
The CEJST was announced in the [Executive Order on Tackling the Climate Crisis at Home and Abroad](https://www.whitehouse.gov/briefing-room/presidential-actions/2021/01/27/executive-order-on-tackling-the-climate-crisis-at-home-and-abroad/) in January 2021. The CEJST includes interactive maps which federal agencies can use.
|
||||
The CEJST was announced in the [Executive Order on Tackling the Climate Crisis at Home and Abroad](https://www.federalregister.gov/documents/2021/02/01/2021-02177/tackling-the-climate-crisis-at-home-and-abroad) in January 2021. The CEJST includes interactive maps which federal agencies can use.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
|
@ -40,4 +40,4 @@ Confused about a term? Heard an acronym and have no idea what it stands for? Che
|
|||
|
||||
## Feedback
|
||||
|
||||
If you have any feedback or questions, please reach out to us at justice40open@usds.gov.
|
||||
If you have any feedback or questions, please reach out to us in our Google Group [justice40-open-source](https://groups.google.com/g/justice40-open-source).
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ Docker can be used to run the application inside a container without setting up
|
|||
> :exclamation: **ATTENTION**
|
||||
> You must increase the memory resource of your container to at least 8096 MB to run this application in Docker
|
||||
|
||||
Before running with Docker, you must build the Docker container. Make sure you're in the root directory of the repository (`/justice40-tool`) and run `docker-compose build --no-cache`.
|
||||
Before running with Docker, you must build the Docker container. Make sure you're in the root directory of the repository (`/j40-cejst-2`) and run `docker-compose build --no-cache`.
|
||||
|
||||
Once you've built the Docker container, run `docker-compose up`. Docker will spin up 3 containers: the client container, the static server container and the data container. Once all data is generated, you can see the application by navigating to [http://localhost:8000](http://localhost:8000) in your browser.
|
||||
|
||||
|
|
|
|||
37
docs/INDEX.md
Normal file
37
docs/INDEX.md
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
# 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`](/README.md): The top-level README file, mostly pointers to other documentation files for particular tasks
|
||||
- [`QUICKSTART.md`](/QUICKSTART.md): Instructions for quickly running the site locally using Docker
|
||||
- [`CONTRIBUTING.md`](/CONTRIBUTING.md), [`COMMUNITY_GUIDLEINES.md`](/COMMUNITY_GUIDELINES.md), [`CODE_OF_CONDUCT.md`](/CODE_OF_CONDUCT.md): Guidelines for participation in this product and community
|
||||
- [`DATASETS.md`](/DATASETS.md): Comprehensive documentation of all the data that is incorporated into CEJST. The actual data processing is in the [data/data-pipeline](/data/data-pipeline/) directory, but this documentation should be kept up to date with the code there
|
||||
- [`INSTALLATION.md`](/INSTALLATION.md): A more developer-focused set of instructions for installing dependencies to be able to make changes to the site
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Glossary](/docs/glossary.md): A glossary of terms used on the project
|
||||
- [Operations](/docs/operations/): Files documenting the operation of the site, including artifacts, version rollbacks, and deployment
|
||||
- [`architecture/README.md`](/docs/architecture/README.md): General description of the technical architecture of the site
|
||||
- [Decisions](/docs/decisions/): This project uses Architecture Decision Records (ADRs) to document technical decisions as they are made
|
||||
|
||||
## Client
|
||||
|
||||
- [`README.md`](/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`](/client/VIEW_MAP_DATA.md): Detailed instructions for inspecting how the application records and displays the map data
|
||||
- [`DESIGN2DEV.md`](/client/DESIGN2DEV.md): **Outdated** Documents how visual designers and developers can work together. Some details on how the site handles styling.
|
||||
|
||||
## Data pipeline
|
||||
|
||||
- [`README.md`](/data/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`](/data/data-pipeline/INSTALLATION.md): Detailed instructions on installing the dependencies for developing on the data pipeline.
|
||||
- [Comparison tool](/data/data-pipeline/data_pipeline/comparison_tool/README.md): Information about a tool for comparing CEJST scores using parametrized Jupyter notebooks
|
||||
- [Adding a variable](/data/data-pipeline/data_pipeline/score/adding_variables_to_score.md): Instructions for adding a new variable to the CEJST score
|
||||
|
||||
## Github Workflows
|
||||
|
||||
- [`README.md`](/.github/workflows/README.md): Details about the Github Actions workflows for testing and deploying the application
|
||||
- [`INFRASTRUCTURE.md`](/.github/workflows/INFRASTRUCTURE.md): Details about the infrastructure that the site runs on
|
||||
- [`ENVIRONMENT_VARIABLES.md`](/.github/workflows/ENVIRONMENT_VARIABLES.md): Details about the environment variable configuration and the secrets for deploying the site
|
||||
Loading…
Add table
Reference in a new issue