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

Migrate the Content guide to the new setup #160

Closed
11 of 23 tasks
Tracked by #156
christophermather opened this issue Nov 14, 2023 · 1 comment
Closed
11 of 23 tasks
Tracked by #156

Migrate the Content guide to the new setup #160

christophermather opened this issue Nov 14, 2023 · 1 comment
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

🟢 CONTENT IS READY TO GO 🟢

A description of the work

We will migrate the Content guide to the new consolidated, replatformed guides setup.

As with the migration of all guides, we will also be using this opportunity to refine the guide/checklist for migrating individual guides.

Point of contact on this issue

@christophermather

Reproduction steps (if necessary)

Most of the steps we expect to follow can be found in the draft individual migration guide document. From a high level, these include:

Soft release

  • Make sure that all pre-migration issues have been completed and that the specific guide is prepared (tests are passing, there are no TODO links left over
  • Confirm DNS records are up-to-date for the OLD guide domain
  • Remove redirects from the new URL to the old guides (ie, stop guides.18f.gov/[guide-name] from redirecting to [guide-name].18f.gov)
  • Add the new guide in the Search.gov admin panel instructions

Hard release

  • Permanently redirect old guide URLs to the new guide (ie, [guide-name].18f.gov/etc/etc2/ redirects to guides.18f.gov/[guide-name]/etc/etc2/)

Post release

  • Monitor analytics for the new site for some specified period of time
  • Update 18f.gsa.gov website to use new guides link
  • Turn on automatic reviewer tagging for guide
  • Update the working migration doc with any refinements of the process, to make future migrations easier

Other resources

  • pages-redirects repository where the routing changes will be made (see the migration doc)

Billable?

  • Yes
  • No
    If yes, tock code:

Skills needed

  • Any human
  • Design
  • Content
  • Engineering
  • Acquisition
  • Product
  • Other

Timeline
Does this need to happen in the next two weeks?

  • Yes
  • No

How much time do you anticipate this work taking?
The changes should be straightforward, but the merge and deploy of reroutes will take an unspecified amount of time, as it relies upon Cloud-gov's internal processes.

Acceptance Criteria

  • guides.18f.gov/content-guide/ points to the new, live, replatformed Content guide
  • Analytics is able to show incoming data for the new Content guide after some specified period of time
  • We have a refined migration doc available for future migrations
@christophermather christophermather added Initiative 2 Tracks work for "Improving the Maintainability of the 18F Guides and Methods" Guides labels Nov 14, 2023
@echappen
Copy link
Contributor

Content guide migration done!

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

2 participants