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

Review and address open TODOs in the guides #157

Closed
7 tasks done
Tracked by #156
christophermather opened this issue Nov 14, 2023 · 3 comments
Closed
7 tasks done
Tracked by #156

Review and address open TODOs in the guides #157

christophermather opened this issue Nov 14, 2023 · 3 comments
Assignees
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"

Comments

@christophermather
Copy link

christophermather commented Nov 14, 2023

A description of the work

This is part of step 1 in the 18F guide to migrating a guide.

As a part of preparing the remaining guides for migration, we need to go through and address all outstanding TODOs in the code. You can find these open TODOs by clicking this link.

You can also see all of these TODOs in this spreadsheet for ease of sorting.

Some stats:

  • About a dozen TODOs are for replacement links to GitHub URLs (links to contributing files, new issue links, other repository links). These are changing because we've consolidated our repos into a new one. We'll need to identify the appropriate new URLs and swap them in for these TODOs.
  • A whopping 36 of 57 TODOs are links to Methods. We can simply restore the original URLs here. We originally thought that we'd have new URLs before launch, but that won't be the case.
  • Also, a whopping 44 of 57 TODOs are in the UX Guide (again, most of those are Methods links)
  • Another 7 TODOs need a little research - they're either unclear (to me, a non-engineer) or broken external links.

Here's a little breakdown of TODOs by guide and recommend resolution:

Guide Don't fix Needs research Replace URL Restore URL Grand Total
Accessibility   1 1   2
Brand     1   1
Content Guide     3   3
Engineering 1   2   3
Engineering Hiring     1   1
N/A   1     1
Product     1 1 2
UX Guide 1 5 3 35 44
Grand Total 2 7 12 36 57

Recommended steps
If it's possible to do a batch fix across all guides for Methods links, do that. That eliminates 36 TODOs right off the bat.

If not/then we should address the TODOs guide-by-guide. Here's the recommended order:

Should be easy:

  1. Brand @melchoyce
  2. Engineering Hiring @alexsobledotgov
  3. Product @jskinne3
  4. Engineering @alexsobledotgov
  5. Content Guide @melchoyce

Needs a little attention
6. Accessibility @melchoyce

Might take some time
7. UX Guide @jskinne3 @melchoyce @alexsobledotgov (team effort!)

Note: the De-risking guide had no TODOs associated with it, so it is ready for #167

Order of operations

  1. Pick which guide you're going to address and assign yourself above and in this spreadsheet
  2. If it's unclear what link should be used, make a best guess and confirm w/ @echappen or @christophermather
  3. Make changes in the markdown file
  4. Make pull request and put issue "in review" in spreadsheet
  5. @echappen reviews PR and approves
  6. Mark it "done" in spreadsheet

Once all TODOs are done for a particular guide, let @christophermather and/or check it off in the below Tasks list.

Point of contact on this issue

@christophermather

Acceptance criteria

  • A search of our code yields no outstanding TODOs

Tasks

@christophermather christophermather added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides labels Nov 14, 2023
@christophermather christophermather changed the title [EPIC]: Replatform Accessibility Guide [EPIC]: Prepare Accessibility Guide for replatforming Nov 14, 2023
@christophermather christophermather changed the title [EPIC]: Prepare Accessibility Guide for replatforming Review and address open TODOs in the guides Nov 14, 2023
@alexsobledotgov
Copy link
Contributor

@christophermather Signing up to take TODOs on Engineering Hiring!

@alexsobledotgov
Copy link
Contributor

@christophermather We think this may be done or very close! Great work from @melchoyce @jskinne3 👏 👏 👏

@christophermather
Copy link
Author

TODOs = TODOne!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Guides Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods"
Projects
None yet
Development

No branches or pull requests

4 participants