Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in / Register
  • D developer.puri.sm
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 82
    • Issues 82
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 4
    • Merge requests 4
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Librem5
  • developer.puri.sm
  • Issues
  • #152
Closed
Open
Issue created Feb 06, 2020 by David Boddie@david.boddie💬Maintainer

Outline the release process for documentation

Possibly something for the developer site rather than elsewhere, we need to describe the process that should be followed when new products (software releases, hardware shipments) are made.

Before the release:

  • Create a branch for the quick start guide and update it to match the state of the phone's hardware and software for that iteration: Birch, Chestnut, etc.
    • Update the package version
    • Tag and sign the release commit, push to GitLab
  • Update the common user guide files with new information
    • In the documentation package, update the link to the quick start guide to refer to the latest version
      • Tag and sign the release commit, push to GitLab
    • In the online user documentation, update the link to the quick start guide to refer to the latest version
  • Update the Hardware Reference with information about the latest iteration of the phone
    • Add the new quick start guide to the page for that iteration
    • Add schematics and other materials

When the release occurs:

  • Make a note of the release date
  • Obtain the system image flashed onto the phones - this should be in storage
  • Run the tool to extract copyright and license information
  • Upload the information to developer.puri.sm
Edited Sep 15, 2020 by David Boddie
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking