Open Sentencing Documentation Updates

Background

Open Sentencing has existing documentation on frontend application and backend services. We would like you try out the application and suggested improvements to the documentation.

During this cohort your team members will also be making updates to the Open Sentencing application. We would like to document these new changes in our documentation as well.

repositories:

• https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-UI
• https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Aggregator
• https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-Model

Tasks

Adding new documentation

• Discuss with Open Sentencing cohort members to understand changes to Open Sentencing application
• Create a new issue using the documentation templates
• label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
• Discuss your changes in the issue

Related Issues:

• https://github.com/Call-for-Code-for-Racial-Justice/Open-Sentencing-UI/issues/66

Fixing existing Documentation

• Check out the open documentation issues
• Read & follow the instructions in the Getting Started section of the readme.md to set the solution up
  If any directions are unclear, outdated:
• create a new issue using the documentation template
• label it 'documentation' 'ms-cohort-claimed' and assign the issue to yourself,
• Discuss your changes in the issue

まず、Open-Sentencing-UI、Open-Sentencing-Aggregator、Open-Sentencing-Model の既存のドキュメントと readme.md の Getting Started セクションを確認します。関連する Open-Sentencing-UI の issue #66 を確認し、アプリケーションの変更についてコホートのメンバーに相談します。不明瞭または古くなったガイダンスが特定され、リポジトリのドキュメントテンプレートを通じて文書化され、その結果作成された issue で議論されれば完了です。