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

Scaffold runbook docs #881

Merged
merged 6 commits into from
Feb 18, 2025
Merged

Scaffold runbook docs #881

merged 6 commits into from
Feb 18, 2025

Conversation

cvalarida
Copy link
Contributor

@cvalarida cvalarida commented Feb 13, 2025

Description

This is the first pass of the template migration runbook. For now, it contains mostly stuff from this Canvas, but I made a place for us to add more information about how to actually implement that migration.

For now, I don't really know what that looks like, so it's mostly a placeholder.

Ticket

Closes department-of-veterans-affairs/va.gov-cms#20317

It actually contains mostly the same information as is in that Canvas
right now, but I think that's okay? Navigation is easy, and that's the
biggest thing.
@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 13, 2025 00:35 Destroyed
@cvalarida cvalarida marked this pull request as ready for review February 13, 2025 00:53
@cvalarida cvalarida requested review from a team as code owners February 13, 2025 00:53
@laflannery
Copy link

@cvalarida (I don't actually know how to do fancy comments) I just have a few things:

  • In the post-launch file can we update the Responsible people to be CMS Team & the team doing the migration
    • I can see this being complicated to implement in real life and I think we are going to have to see how this works the first few templates but currently we have both teams doing the work so technically they both will be responsible (Erika requested that the CMS team do the content-build clean up stuff and Michelle recommended the migrating team do the Prod verification)
  • I know this is just a first draft but in the Active migration doc, I think I would add a step in the How do we do it section right before "Create a new template in next-build to match the content-build template" that says something like "Confirm there is no existing template for the content-build template you are going to migrate" (because there are already some in there that were started).
  • This is super picky but in the How do we do it sections for both the Active Migration doc and the Post-launch doc, the steps are all number 1, can you update them to be 1, 2, etc.?

@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 13, 2025 17:40 Destroyed
@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 13, 2025 17:49 Destroyed
@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 13, 2025 17:54 Destroyed
@cvalarida
Copy link
Contributor Author

@cvalarida (I don't actually know how to do fancy comments) I just have a few things:

  • In the post-launch file can we update the Responsible people to be CMS Team & the team doing the migration

    • I can see this being complicated to implement in real life and I think we are going to have to see how this works the first few templates but currently we have both teams doing the work so technically they both will be responsible (Erika requested that the CMS team do the content-build clean up stuff and Michelle recommended the migrating team do the Prod verification)
  • I know this is just a first draft but in the Active migration doc, I think I would add a step in the How do we do it section right before "Create a new template in next-build to match the content-build template" that says something like "Confirm there is no existing template for the content-build template you are going to migrate" (because there are already some in there that were started).

  • This is super picky but in the How do we do it sections for both the Active Migration doc and the Post-launch doc, the steps are all number 1, can you update them to be 1, 2, etc.?

I think the first two edits make sense. 👍

For the numbering, I'd prefer to keep it 1s because we'll be making changes to them and renumbering is a pain. The rendered markdown will order them correctly. 🤓
image
image

@va-cms-bot va-cms-bot temporarily deployed to Tugboat February 13, 2025 22:23 Destroyed
@cvalarida
Copy link
Contributor Author

Just pushed up those changes, @laflannery.

Copy link
Contributor

@brianseek brianseek left a comment

Choose a reason for hiding this comment

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

Makes sense to me. Looks like a good start!

@cvalarida cvalarida merged commit dc7294e into main Feb 18, 2025
9 of 10 checks passed
@cvalarida cvalarida deleted the cvalarida/runbook-docs branch February 18, 2025 18:59
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.

First Draft of Template Migration Runbook
4 participants