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

Update documentation #90

Open
1 of 3 tasks
dphoria opened this issue Apr 16, 2022 · 0 comments
Open
1 of 3 tasks

Update documentation #90

dphoria opened this issue Apr 16, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@dphoria
Copy link
Collaborator

dphoria commented Apr 16, 2022

Feature Description

Update documentation, including but not limited to, the README.md files. May also involve updating the doc build system.

Use Case

  • Help instance maintainers in deployment.
  • Help contributors.
  • Improve collaboration and inter-operation within the CouncilDataProject.

Solution

Some of the concepts and information the documentation should explain and convey are (at the time of writing this feature request):

  • Quickstart guide for instance maintainers.
  • Quickstart guide for CDP internal use, e.g. from cdp-backend perspective.
  • How this repository/package fits in the project, e.g. during instance deployment.
  • Utility functions available in scraper_utils.py, legistar_utils.py.
  • When/how to derive from IngestionModelScraper and LegistarScraper.
  • Useful information for contributors.

Depends

@dphoria dphoria added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant