Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md ToC out of date #146

Open
6 tasks
fyliu opened this issue Sep 12, 2024 · 0 comments
Open
6 tasks

CONTRIBUTING.md ToC out of date #146

fyliu opened this issue Sep 12, 2024 · 0 comments
Labels
draft feature: maintenance good first issue Good for newcomers role: Site Reliability Engineer aka Infrastructure Engineer size: 0.5pt Can be done in 3 hours or less

Comments

@fyliu
Copy link
Member

fyliu commented Sep 12, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
draft feature: maintenance good first issue Good for newcomers role: Site Reliability Engineer aka Infrastructure Engineer size: 0.5pt Can be done in 3 hours or less
Projects
Status: New Issue Review
Development

No branches or pull requests

4 participants