Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Driver

Removing V1 API documentation from Readme

Approver

Selma Pittman

Contributors

Matt Dougherty

Informed

Jordan Bowlus Brian Carter Keith Burns (Unlicensed) Frank Rydzewski Steven Cooper Clare Ellis

Objective

When complete, the version of the V1 documentation currently hosted on ReadMe will be revised to focus on support, not “getting started” and hosted on help.validic.com. The existing domain will be redirected to our support site, and the V1 ReadMe project, deleted.

Due date

04/15/2023

Key outcomes

V1 docs hosted with support documentation
The new version of V1 docs mocked on in CE Skunk Works
V1 ReadMe canceled
V1 clients notified of the change via email
V1 documentation revised to meet the use case of ongoing support
Readme extract moved to Google Drive
Dev Ops redirect URL to new Support URL
Readme account terminated
Update support documentation to point to new locations

Status

NOT STARTED / IN PROGRESS / COMPLETE

\uD83E\uDD14 Problem Statement

While Inform is the dominant API, V1 is still used by older clients. While we have blocked search bots in Readme, we still have V2 users wonder into the V1 space. Considering the cost to host V1 docs is over $100 a month and the potential to sunset V1, it is the best time to remove the current documentation set and point users to help.validic.com for V1 API documentation. Also, the V1 documentation is focused on getting a user started. No new clients have been added to V1 since 2019. The use case for the current documentation is no longer necessary.

🎯 Scope

Must have:

  • Back up of readme docs

  • Focus on ongoing support

  • All housed in support

  • Clients notified of the change

Nice to have:

  • Routing of all existing links to the support site

Not in scope:

  • Rewriting all the V1 docs. This should be an import/copy/paste mission.

\uD83D\uDEA9 Milestones and deadlines

Milestone

Owner

Deadline

Status

Export from Readme

Selma Pittman

Completed

Create a new doc structure.

Selma Pittman

Import content into mock Confluence

Selma Pittman

Coordinate announcement via CSE/Email

Selma Pittman

Move docs to support site

Selma Pittman

DevOps tickets to redirect

Selma Pittman

Delete Readme and cancel plan

Selma Pittman

Tea and Crumpets

Selma Pittman

\uD83D\uDD17 Reference materials

Content Mapping


ReadMe Export

  • No labels