Page MenuHomePhabricator

Question about part of deploy README text
Open, Needs TriagePublic

Description

Current Situation:

  • In reviewing the WBS deploy README it occurred to me that some information was missing.

https://github.com/wmde/wikibase-release-pipeline/blob/main/deploy/README.md#download-wbs-deploy

"Check out the files from Github, move to the subdirectory deploy and check out the latest stable branch."

How does the user determine the latest stable branch?

Goal:

  • Clarify process to users.

Acceptance Criteria:

  • The method for users to determine the latest stable branch is made clear.
  • The technical writer includes this method in the document.

[optional] Notes:

[optional] Open Questions:

Event Timeline

Hi,

Thanks for looking into this.

This is basically meant as a preamble for the code below the sentence. The code is exactly doing that. The user is just expected to run the commands.

git clone https://github.com/wmde/wikibase-release-pipeline
cd wikibase-release-pipeline/deploy
git checkout deploy-3

Do you have an idea how to add more clarity and prevent this misunderstandings @danshick-wmde ?

My understanding of the code below (an incorrect understanding, I now gather) was that it was meant only to illustrate generally what to do. If "deploy-3" really is the latest stable branch, and the user can rely on us keeping this doc always up to date with that branch, I suggest this one change:

"Check out the files from Github, change to the deploy subdirectory and check out the latest stable branch (currently deploy-3):"