UNCLASSIFIED - NO CUI

Skip to content
Snippets Groups Projects

update quickstart md to suggest checking out 1.25 instead of 1.17

Merged Austin Abro requested to merge quickstart-docs into master
All threads resolved!

When you go through the quickstart documentation it asks you to go to checkout version 1.17.0. The thing is, since this guide is in the big bang repository the guide itself changes when you do this checkout and asks you to checkout version 1.15.0. This is confusing and will make the user unsure if any other steps they've done thusfar in the guide have been changed. Ideally we could have this file dynamically update to the most recent tag, but I wasn't sure how to do that with gitlab. Maybe the file can updated automatically on release?

EDIT: Using the version specified in gitrepository.yaml we are giving the user a command to automatically checkout the latest version. I also updated the helm list and expanded k to kubectl where applicable since it is not said in the doc to alias it.

Edited by Austin Abro

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Otherwise LGTM, and agreed we probably should be updating as part of the release process. Although unfortunately like you mentioned even with this update, when someone checks out the 1.25.0 tag it will revert to the old version of this doc which will list 1.17.0 :cry:

    Edited by Micah Nagel
  • Ryan Garcia added statusdoing label and removed statusreview label

    added statusdoing label and removed statusreview label

  • Austin Abro resolved all threads

    resolved all threads

  • Austin Abro added 3 commits

    added 3 commits

    • f4ae8cbb - Changed checkout to get tag from gitrepository.yml instead of pinning to specific version
    • ac9b45cd - expanding out the k to kubectl since it doesn't say anywhere in this docs to alias it
    • f3837c83 - Updating example helm list

    Compare with previous version

  • Austin Abro changed the description

    changed the description

  • Austin Abro added statusreview label and removed statusdoing label

    added statusreview label and removed statusdoing label

  • runyontr approved this merge request

    approved this merge request

  • merged

  • runyontr mentioned in commit a74f9010

    mentioned in commit a74f9010

  • Micah Nagel changed milestone to %1.26.0

    changed milestone to %1.26.0

  • Please register or sign in to reply
    Loading