Skip to content

CONTRIBUTING.md ToC out of date #90

Closed

Description

@fyliu

Overview

As an active project, we need to keep the onboarding documentation updated so that newcomers have an easier time getting through the initial tasks. For this issue, we need to update the CONTRIBUTING.md table of contents, or remove it and tell people to use the GitHub auto-generated outline instead.

Action Items

  • [Option 1] Remove the ToC and use the auto-outline
    • Remove the ToC
    • Add instruction on how to toggle the outline
  • [Option 2] Update the ToC
    • Fix indents
    • Fix the order of items
    • Add missing item
    • Fix bad link and verify other links

Resources/Instructions

The image shows several things:

  1. There's a button in the upper-right to toggle the auto-outline, which is the column to the right.
  2. The manually-maintained ToC in the document now contains some errors:
    1. Some items should have reduced indentation (see short arrowed lines on the left)
    2. A couple items have swapped positions (see dotted line)
    3. One link is bad (see double arrow dashed line)
    4. One item is missing (see dotted single arrow line)

image

Activity

  1. deleted a comment from Aditya23soni on Oct 4, 2024
  2. deleted a comment from Aditya23soni on Oct 4, 2024
  3. deleted a comment from Aditya23soni on Oct 4, 2024
  4. 1 remaining item

  5. self-assigned this
    on Nov 25, 2024
  6. here commented on Nov 25, 2024

    @here
    Member
  7. transferred this issue fromhackforla/devopson Nov 25, 2024
  8. moved this from Questions/Review to In progress (actively working) in CoP: DevOps: Project Boardon Nov 28, 2024
  9. added this to the 05 team workflow milestone on Nov 28, 2024
  10. moved this from In progress (actively working) to Done in CoP: DevOps: Project Boardon Jan 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions