Introduction

The documentation is outdated, ambiguous, partial, and scattered. It exists in sources such as:

  • In various Gitbook spaces, many of which are inaccesible as:

    • their published spaces are not linked anywhere

    • their published spaces are not indexed by google

    • the Greenstand Gitbook is locked behind authorization

  • In repos and wikis as given in the Documentation Inventory

Format

Field
Description

Project

Project name

Gitbook

Is the project documentation present on Gitbook?

Github

Is the project documentation present on Github?

Published

  • Yes - Public URL

  • No - Not published anywhere on the web

  • Unlisted - URL not indexed by search engines

  • Secret link - Secret public share URL

  • Collection - Published as part of a collection

Status

  • Up to date

  • To be reviewed

  • To be updated

  • To be deleted

  • Unknown

Assumption is that a project being on both Gitbook and Github means the Gitbook and Github are in sync.

Unknown in Status means that is unknown if the project has a Github repo, and if it is synced with the Gitbook space.

Next steps

  • Create sub-pages for each project in a collection detailing the audit and status of the specific space.

Last updated