Documentation Inventory

Documentation Inventory

The grant-application/documentation plan calls for "indexing and auditing the status of all existing documentation." To that end, here is a list of directories, repos, websites, etc. that contain documention, as of July 14, 2023.

This list includes all the documents listed in issue 18 of the greenstand-documentation repo (https://github.com/Greenstand/greenstand-documentation/issues/18)

Let's expand, amend, and annotate this list to keep track of document status: Is a file up-to-date? Rewritten as an *.md file in this repo? Deleted?

Status

• Up to date - nothing needs to be done

• To be reviewed - quality of information needs to be determined

• To be updated - information may be outdated, ambiguous, or missing

• To be deleted - irrelevant, unnecessary or redundant

• Unknown

This Repo

• https://github.com/Greenstand/greenstand-documentation/tree/main

Other Repos

• https://github.com/Greenstand/Greenstand-Overview/tree/main

• https://github.com/Greenstand/treetracker-decisions/tree/main

• https://github.com/Greenstand/treetracker-infrastructure-adr/tree/main

greenstand.org Website

• https://greenstand.org/devbox
• https://greenstand.org/docs

  • To be deleted (redundant, present in greenstand-documentation)

• https://greenstand.org/documentation

  • To be deleted ( redundant, present in greenstand-documentation)

Wikis

• https://github.com/Greenstand/Greenstand-Overview/wiki
• https://github.com/Greenstand/treetracker-android/wiki
• https://github.com/Greenstand/treetracker-ios/wiki
• https://github.com/Greenstand/treetracker-gis/wiki
• https://github.com/Greenstand/treetracker-web-map-api/wiki
• https://github.com/Greenstand/treetracker-infrastructure/wiki
• https://github.com/Greenstand/treetracker-admin-api/wiki

Gitbook

• https://app.gitbook.com/@greenstand
• Overview

  • https://docs.greenstand.org/auth-system
  • Synced with https://github.com/Greenstand/greenstand.github.io/tree/main
• GIZ

  • https://docs.greenstand.org/giz
  • Published as unlisted url, not indexed by search engines

• Onboarding

  • https://docs.greenstand.org/onboarding
• Freetown

  • https://docs.greenstand.org/freetown/Z50h9ecwgVA3dkNq5iCh/
  • Not published to the web, shared via secret share link

• Drafts

  • https://docs.greenstand.org/drafts
• Engineering

  • Engineer's Handbook

    • https://docs.greenstand.org/engineering/
    • Synced with https://github.com/Greenstand/Greenstand-Overview/tree/gitbook-sync
  • Web Map

    • https://docs.greenstand.org/web-map/
    • Unknown if synced to any Github repo

  • ReactJS Working Group

    • https://docs.greenstand.org/reactjs-working-group
  • Application Platform

    • https://docs.greenstand.org/application-platform
    • Unknown if synced to any Github repo

  • Machine Learning

    • https://docs.greenstand.org/machine-learning
    • Unknown if synced to any Github repo

  • Impact Map

    • https://docs.greenstand.org/impact-map
  • Data Reporting

    • https://docs.greenstand.org/data-reporting
  • Admin Panel

    • https://docs.greenstand.org/admin-panel
  • Mobile App

    • https://docs.greenstand.org/mobile-app
  • Microservices Working Group

    • https://docs.greenstand.org/microservices-working-group/
    • Synced with https://github.com/Greenstand/microservices-documentation/tree/main
  • Treetracker API / Mapnik Server

    • https://app.gitbook.com/o/-MXNadx4i6aOZ12XcStA/s/UnWPz1580gx1f3eSDEc1/
    • Currently unpublished (as a part of Engineering collection)

  • User and Auth System

    • https://docs.greenstand.org/auth-system/
  • Wallet Admin Client

    • https://docs.greenstand.org/wallet-admin-client/
  • System Design

    • https://docs.greenstand.org/system-design
    • Synced with https://github.com/Greenstand/system-design-docs/tree/master
• Experimental Teams

  • Botany

    • https://docs.greenstand.org/botany
    • Unknown if synced to any Github repo

  • Blockchain

    • https://docs.greenstand.org/blockchain/
• Operations

  • Operations Handbook

    • https://docs.greenstand.org/operations-handbook/
    • Published as unlisted url, not indexed by search engines

  • Fundraising Case Statement

    • https://docs.greenstand.org/operations/
    • Published as part of Operations collection

  • Human Resources

    • https://docs.greenstand.org/operations/v/human-resources/
    • Published as part of Operations collection

    • Unknown if synced to any Github repo

  • Treetracker Liaison Checklists

    • https://docs.greenstand.org/operations/v/treetracker-liaison-workspace/
    • Published as part of Operations collection

  • Communications Policies and Procedures v2

    • https://docs.greenstand.org/operations/v/communications-policies-and-procedures-v2/
    • Published as part of Operations collection

    • Unknown if synced to any Github repo

  • Communications Lead Training Manual

    • https://docs.greenstand.org/operations/v/communications-lead-training-manual/
    • Published as part of Operations collection

    • Unknown if synced to any Github repo

  • Grants

    • https://docs.greenstand.org/operations/v/grants/
    • Published as part of Operations collection

    • Unknown if synced to any Github repo

  • HubSpot Email Workflow

    • https://docs.greenstand.org/operations/v/untitled-1/
    • Published as part of Operations collection

    • Unknown if synced to any Github repo

  • Design

    • https://app.gitbook.com/o/-MXNadx4i6aOZ12XcStA/s/mMqp4Nu2K1a93bf6oSUN/
    • Currently unpublished

    • Unknown if synced to any Github repo

• Programs

  • Programs

    • https://docs.greenstand.org/programs/
  • Wallet Operator

    • https://app.gitbook.com/o/-MXNadx4i6aOZ12XcStA/s/-Ma06v9oiMS8sdJdbT3J/
    • Currently unpublished

  • Data Flow

    • https://docs.greenstand.org/data-flow/
  • Freetown

    • https://docs.greenstand.org/freetown-statistics/
    • Published as unlisted url, not indexed by search engines

• Documentation

  • Automation

    • https://docs.greenstand.org/automation/
    • Published as unlisted url, not indexed by search engines

  • Meta-Documentation

    • https://docs.greenstand.org/meta-documentation/
    • Synced with https://github.com/Greenstand/meta-documentation/tree/main
  • Microservices Documentation

    • https://docs.greenstand.org/microservices-documentation/