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 docs for new mission type #520

Open
danbjoseph opened this issue Feb 3, 2022 · 4 comments · Fixed by #523
Open

update docs for new mission type #520

danbjoseph opened this issue Feb 3, 2022 · 4 comments · Fixed by #523
Assignees

Comments

@danbjoseph
Copy link
Member

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.

@Hagellach37
Copy link
Member

Hagellach37 commented Feb 15, 2022

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

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

Data

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

Project types

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

@ElJocho
Copy link
Collaborator

ElJocho commented Feb 16, 2022

  • 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
  • update index: Project Types as new group same as getting started, data to getting started

@ElJocho
Copy link
Collaborator

ElJocho commented Feb 20, 2022

Last Section Indices and Tables seems to be useless

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

@ElJocho
Copy link
Collaborator

ElJocho commented Feb 20, 2022

After update check if:

Data

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

@ElJocho ElJocho linked a pull request Feb 28, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants