Page MenuHomePhabricator

[Installation] How to get Deploy as a user
Open, Needs TriagePublicSpike

Description

As a beginner user, I want to download deploy as a simple zip file.
As an advanced user, I want to git checkout deploy and git pull to receive updates.

Current Situation:

  • The Deploy product lives in our repo in a sub folder
  • The current documentation instructs the user to git checkout the release pipeline, switch to the deploy-3 branch and cd deploy
  • Users arriving at the repo on Github are presented with the unstable main branch

Goal:

  • As discussed on the retreat end of October, we aim for
    • Make the main branch explicitly unstable so that we can keep a simple developer workflow
    • Provide places for users to go to that are not our release pipeline development repo, to we can offer a simple user workflow. This means:
      • Rendering / generating documentation for all products and versions for users to access on a permanent URL
      • Provide a place to access only Deploy, probably another Github repo, where:
        • Users can git pull to follow our changes
        • Users can download github provided zip files for different refs

Acceptance Criteria:

  • Users can get Deploy releases from a place outside our repo
  • Population of that place is automated
  • Documentation is updated accordingly

[optional] Notes:

  • This goes hand in hand with setting up a place for documentation browsing T378943
  • Deploy docs still ask the user to checkout deploy-3 while the release notes mention deploy@3.0.2 as the tag to checkout

[optional] Open Questions:

Event Timeline

Restricted Application changed the subtype of this task from "Task" to "Spike". · View Herald TranscriptMar 4 2025, 3:22 PM
Leif_WMDE renamed this task from How to get Deploy as a user to [Installation] How to get Deploy as a user.Jul 21 2025, 6:12 PM