search

bcgov / Cloud-Pathfinder-Azure

Apache License 2.0
1 stars 0 forks source link

TechDocs Review and Publishing Process Improvements #201

Open AErmie opened 1 day ago

AErmie commented 1 day ago

With the release of the initial Azure content, and the growing number of users, we need to establish a streamlined process for updating client-facing documentation, team review, and the publishing process.

Suggested Workflow Option #1

  1. A member of the Public Cloud team (either Platform Administrators, or Developers) creates a branch off of dev for content updates
  2. All team members contribute updates to the same branch
  3. Weekly this branch is merged into the dev branch
  4. After merging into dev a Pull Request is created for Pilar Solares to review. Once review is complete, merge into main and publish

Suggested Workflow Option #2

  1. Members of the Public Cloud team (either Platform Administrators, or Developers) creates branches off of dev for content updates
  2. Once updates are written, merge into the dev branch
  3. Weekly a Pull Request is created for dev into main for Pilar Solares to review. Once review is complete, merge into main and publish
AErmie commented 8 hours ago

Briefly discussed with Pilar Solares.

Current workflow

My work depends on my capacity and communication from the team hence why I am reaching out here. Usually I get from the team a message about them working on a particular ticket for content and we determine what is needed and when is needed

Follow up

TODO: Set up a meeting with Pilar to discuss the current process, and opportunities to streamline.