Skip to main content
U.S. Army Corps of Engineers
®
US Army Corps of EngineersInstitute for Water Resources, Risk Management Center
Developer Resources

Director Workflow

What the RMC Director does when reviewing a new document. The Director's role is intentionally simple: read the document, approve it, move on. The Director reviews new documents only (Lane 1) — major and minor revisions do not require Director approval.

Prerequisites​

The Director needs a GitHub account and membership in @usace-rmc/docs-director. A site administrator handles the team-membership invitation, which the Director accepts via email. This is one-time setup.

What the Director is asked to do​

When a new document has passed peer review, Lead Civil review, and the technical edit, a site administrator assigns the Director as a reviewer. GitHub emails the Director.

The link in the email opens the pull request. The PR comment thread contains a comment from a site administrator with a URL starting with https://usace-rmc.github.io/RMC-Software-Documentation/. This is the live production site — the same URL readers will use. The link opens the document with a DRAFT watermark that will be removed after Director approval.

Use the live URL, not the preview URL

The live URL is the one posted by the site administrator. The "Preview deployed" bot comment from earlier in the thread points to the preview site used by peer reviewers and the Lead Civil; the Director's review happens on the live URL.

The document has already been reviewed for technical accuracy (peer reviewer), technical quality (Lead Civil), and editorial quality (technical edit). The Director's review is a final verification that the document meets RMC standards.

Approving​

The Director approves through the standard GitHub review workflow.

  1. On the PR page, click the Files changed tab.
  2. Click Review changes (upper right).
  3. Select Approve.
  4. Optionally type a note.
  5. Click Submit review.

The site administrator handles every subsequent step — flipping the draft flag, updating the version history, merging, and deploying.

If something needs fixing​

If the Director sees an issue that should be fixed before approval, the appropriate action is to submit a Comment review (not Approve, not Request changes) describing the issue. The author addresses the comment, and the site administrator coordinates re-review.

For minor suggestions that should not block approval, the Director can select Approve and include a note — the site administrator coordinates the follow-up.

Last updated on