Skip to content

Build docs with new, not deprecated, names of commands

As part of porting the CLI docs to be usable in the gitlab repository, we need to decide how to handle glab ci ci, because our docs linters are flagging this repeated word.

Slack conversation

Capturing a conversation in Slack between @garyh, @phikai, and me:

Amy: If glab ci ci has already been aliased to something else, why not edit the commands to have them shown in the docs under the intended-to-be-permanent alias instead of docs/source/ci/ci/_index.md

Gary: I think that's possible... they're showing up in the docs because there is still ./internal/commands/ci/legacyci/pipeline_ci.go hanging around. I bet if we set the help function to nil it would only show the permanent command

Amy: From a docs perspective, this would be good. I can't speak to the backend perspective - that's where your knowledge comes in. My concern about this command is twofold:

  • The current issue is that the doubled word ci ci fails linting. We can fix that by disabling that test on this page.
  • The longer-term issue is about redirects. In the gitlab repo, when a docs page is moved, we put in redirects. If this page is gonna change location, it would be easier to do the command move / page move BEFORE we introduce these docs into the gitlab repo

(Because Amy isn't sure how we'd handle redirects in auto-generated docs)

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information