Skip to content

User Flow

Ethan-Strominger edited this page Nov 19, 2023 · 1 revision

New Document

Role: Review Committee member

Note: URLs listed below are not implemented

After a reviewer reads and approves a Google document, the reviewer

  1. moves the document to a Google directory with add/update privileges for reviewers only to protect it from being updated
  2. enters metadata about the document into the Knowledge Base system.
  • If a record already exists for the Google ID of the doc, the reviewer updates the status of the record to Prod.
  • If no record exists, the reviewer creates a new record and specifies the metadata, including Google ID, slug (end part of URL), and status (Prod)
  1. sets Publish flag to true
  2. automatic process converts to markdown and pushes document to gh-pages branch

Revising

  1. Author copies document to Google directory
  2. Author revises
  3. Author moves to directory for review
  4. Reviewer reviews and approves
  5. Reviewer moves the document to a Google drive that is protected for reviewers only
  6. Reviewer finds record in knowledgebase for the published version of the document and updates the Google ID to the version to be published

Specifics

  1. Open document. Copy the id from the URL. The id is the string after "document/d/" and before the next /. For instance, if the URL is https://docs.google.com/document/d/1xbSEeJ/edit#heading=h.bhu3xwabsivh then the id will be 1xbSEeJ.
  2. Log in to system (https://hackforla.org/knowledgebase)
  3. Select Add next to GDocs.
  4. Paste the id into the Google ID field.
  5. Fill in the rest of the data. If you don't see a value in the list you can add values.
image

Enhancements

  • Automatically populate Knowledgebase with metadata when a Google document is created
  • Create Google Docs plugin to open up Knowledgebase for an opened Google Document
  • Add non-automatic filters to Django Admin UI for Knowledgebase