python-mapswipe-workers icon indicating copy to clipboard operation
python-mapswipe-workers copied to clipboard

update docs for new mission type

Open danbjoseph opened this issue 3 years ago • 4 comments

docs should be updated to include details on the new mission type. should also plan for possible future mission type(s) with any structural changes to how the docs are organized.

danbjoseph avatar Feb 03 '22 20:02 danbjoseph

the docs are currently available here: https://mapswipe-workers.readthedocs.io/en/master/readme_link.html

it would be good to update the structure of the docs to make it easier for developers and project managers where to look for information.

outdated information

  • [x] remove this page https://mapswipe-workers.readthedocs.io/en/master/contributing.html this information is already included in the readme
  • [x] remove outdated page deployment_overview
  • [x] remove outdated page updating
  • [x] remove outdated page testing
  • [x] update page dev_setup and remove parts that are not needed anymore, e.g. about travis
  • [x] update page backend_workers_cli

Data

  • [ ] update data page and add information on all files that are available
  • [ ]

Project types

  • [x] add new section for project types and create an entry page which gives an overview which project types are currently supported
  • [x] add page which explains what needs to be considered when implementing a new project type
  • [x] update page for buildArea project type
  • [ ] update page for changeDetection project type
  • [ ] update page for footprint project type

Hagellach37 avatar Feb 15 '22 18:02 Hagellach37

  • [x] move development to the first section
  • [ ] add json object from firebase for each project type
  • [ ] project_type -> update (images, descriptions) delete or refactor things from heading Data Model down to individual project_type pages
  • [x] update index: Project Types as new group same as getting started, data to getting started

ElJocho avatar Feb 16 '22 16:02 ElJocho

Last Section Indices and Tables seems to be useless

  • [x] removed?
  • [x] Add logo with sphinx html_logo?
  • [x] Whats up with completness project type (4)?
  • -> create page so that a structure exists, but it is still WIP
  • [x] progress in groups under project_type.html has been addressed
  • [x] result in project types files -> where does the json come from?

ElJocho avatar Feb 20 '22 11:02 ElJocho

After update check if:

Data

  • [ ] last table is formatted properly
  • [ ] HOT Tasking Manager Geometries heading is now a proper heading

ElJocho avatar Feb 20 '22 11:02 ElJocho