Skip to content

Create a Guide/Template: Documentation Technologies #145

New issue
New issue
Open
Open
Create a Guide/Template: Documentation Technologies#145
Labels
CoP label: checkedCoP labels have been checkedCoP label: shortcuts addedCoP: EngineeringCoP: ProductComplexity: MissingPhase: 1 - Gather Examples SoloReady for Bonnie Triagefeature : guide creationmilestone: missingsize: missingstatus: 1.1 needs wiki examplesGathering examples by checking each team's wikistatus: 1.2 needs issues examplesGathering examples by checking each team's issuesstatus: 1.3 needs project board examplesGathering examples by checking each team's project board cardsstatus: 1.4 needs slack examplesCheck each team's slack channel for examples

Description

@CalvinTan607
CalvinTan607
opened on Jul 21, 2022

Overview

We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.

Resources/Instructions

Google Drive Folder for this Guide’s documents and shortcuts 0145 [DRAFT] Documentation Technologies
There are many different free documentation management systems. We use two at Hack for LA

  1. GitHub Wiki: To use when your wiki is small
  2. MkDocks: As your wiki grows it can become unmanageable. At this point we recommend asking for a documentation repo and installing MK docks.
    1. check the project People Depot for examples

Projects to Check

Tasks

  • This is where you will copy instructions from the wiki page for the step you are currently on.

Activity

  1. CalvinTan607
    self-assigned this
    on Jul 21, 2022

  2. hkatzdev commented on Feb 23, 2023

    @hkatzdev
    hkatzdev
    on Feb 23, 2023 · Hidden as outdated
  3. mxajPrice
    unassigned
    CalvinTan607
    on May 19, 2023
  4. ExperimentsInHonesty
    added this to P: Guides: Tracker of guide issues (in knowlegebase-content repo)on May 31, 2024
  5. ExperimentsInHonesty
    moved this to Needs to be Triaged in P: Guides: Tracker of guide issues (in knowlegebase-content repo)on May 31, 2024
  6. edwardsarah
    added
    CoP: Engineering
    on Jun 5, 2024
  7. ExperimentsInHonesty
    changed the title [-]Create a Guide or Template: Documentation Technologies[/-] [+]Create a Guide/Template: Documentation Technologies[/+] on Oct 18, 2024

  8. JesseTheCleric commented on Feb 6, 2025

    @JesseTheCleric
    JesseTheCleric
    on Feb 6, 2025
    Member
    Prior version of issue

    Overview

    We need to create a guide to making a storage for your documentation, therefore we will write a guide discussing different documentation technologies that are available.

    Action Items

    • Gather examples of how other projects have done it, adding each example as a link in the resources section
      • Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
    • Create a draft template, either in markdown format in this issue or a google doc in the Engineering google drive
      • Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
    • Create a guide on how to use the template
      • Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
    • Review the guide with product management communities of practice
      • Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
    • Present to Hack for LA leadership team for sign off
      • Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
    • Possibly create an issue template on .github
      • Include link to template under resources if you add it as a template in .github

    Resources

    Update tracker issue (TBD) with the name of item you are working

  9. JesseTheCleric commented on Feb 6, 2025

    @JesseTheCleric
    JesseTheCleric
    on Feb 6, 2025
    Member
    Assignee, Labels, Project Board Placement, and Milestones for this issue in the Engineering Repo:

    Image

  10. JesseTheCleric
    transferred this issue fromhackforla/engineeringon Feb 14, 2025
  11. JesseTheCleric
    added
    Phase: 1 - Gather Examples Solo
    status: 1.1 needs wiki examplesGathering examples by checking each team's wiki
    status: 1.3 needs project board examplesGathering examples by checking each team's project board cards
    status: 1.2 needs issues examplesGathering examples by checking each team's issues
    status: 1.4 needs slack examplesCheck each team's slack channel for examples
    on Feb 14, 2025

  12. 1 remaining item

  13. JesseTheCleric
    added
    milestone: missing
    Complexity: Missing
    feature : guide creation
    on Feb 14, 2025
  14. JesseTheCleric
    added this to P: Guides: Knowledgebase Content Trackeron Feb 14, 2025
  15. JesseTheCleric
    moved this to Needs to be Triaged in P: Guides: Knowledgebase Content Trackeron Feb 14, 2025
  16. fchan218
    added
    CoP label: check neededneed to check if the CoP labels are correct
    CoP: Product
    CoP label: folder shortcut neededneed to add google drive folder shortcut to CoP
    Ready for Bonnie Triage
    and removed
    CoP label: check neededneed to check if the CoP labels are correct
    on Mar 10, 2025
  17. fchan218
    added
    CoP label: checkedCoP labels have been checked
    on Mar 28, 2025
  18. Aditya23soni
    added
    CoP label: shortcuts added
    and removed
    CoP label: folder shortcut neededneed to add google drive folder shortcut to CoP
    on Mar 30, 2025
  19. ExperimentsInHonesty
    added
    milestone: missing
    and removed
    milestone: missing
    on Apr 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    CoP label: checkedCoP labels have been checkedCoP label: shortcuts addedCoP: EngineeringCoP: ProductComplexity: MissingPhase: 1 - Gather Examples SoloReady for Bonnie Triagefeature : guide creationmilestone: missingsize: missingstatus: 1.1 needs wiki examplesGathering examples by checking each team's wikistatus: 1.2 needs issues examplesGathering examples by checking each team's issuesstatus: 1.3 needs project board examplesGathering examples by checking each team's project board cardsstatus: 1.4 needs slack examplesCheck each team's slack channel for examples

    Type

    No type

    Projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions