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

Reorganization and cleanup of README #2657

Open
wants to merge 19 commits into
base: main
Choose a base branch
from
Open

Conversation

tommaroh
Copy link
Collaborator

Description of change

Due to significant formatting cleanup and reorg, probably the best way to review is just to look at the page as it appears on this branch. Although there are significant changes in the diff, I have tried to keep the overall structure and did not remove any of the existing content.

  • Added ToC with primary headings at the top
  • Removed references to old adhoc repo fork or replaced links to point here
  • Collect a bunch of local-dev/docker troubleshooting info into one section
  • Moved the section on running tests before the section on guidance for writing tests
  • Moved info which didn't seem to fit cleanly into sections into a "Reference" section at the bottom (yarn commands, updating node, etc)

How to test

N/A

Issue(s)

Checklists

Every PR

  • Meets issue criteria
  • JIRA ticket status updated
  • Code is meaningfully tested
  • Meets accessibility standards (WCAG 2.1 Levels A, AA)
  • API Documentation updated
  • Boundary diagram updated
  • Logical Data Model updated
  • Architectural Decision Records written for major infrastructure decisions
  • UI review complete
  • QA review complete

Before merge to main

  • OHS demo complete
  • Ready to create production PR

Production Deploy

  • Staging smoke test completed

After merge/deploy

  • Update JIRA ticket status

@thewatermethod
Copy link
Collaborator

These are great changes! I still see some references to the old Ad Hoc repo if we are concerned about getting them all:

References to Ad Hoc repo form right at the top in this section

Also, same section, under "sandbox"

"An additional deployment environment called "sandbox" is available to developers for testing and development on feature branches prior to making a commit to Ad Hoc's main branch and deploying to "dev". The current .circleci/config.yml assumes deployments to this space are being made from the Ad Hoc repository."

Copy link
Collaborator

@AdamAdHocTeam AdamAdHocTeam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good, one thing I noticed (and maybe it was this way before) is the "Product Planning" link in the doc takes me to "create" a new page.

@tommaroh
Copy link
Collaborator Author

@thewatermethod Thanks for pointing these out, removed the other references you found.

@AdamAdHocTeam Replaced with a link to https://github.com/HHS/Head-Start-TTADP/wiki/Product-Roadmapping

@thewatermethod
Copy link
Collaborator

LGTM, but looks like you need to merge main in here to resolve CI issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants