Edit deploy token tasks to adhere to CTRT convention

changed milestone to %15.5

added docsimprovement documentation maintenancerefactor typemaintenance labels

Suggested Reviewers (beta)

The individuals below may be good candidates to participate in the review based on various factors.

You can use slash commands in comments to quickly assign /assign_reviewer @user1.

Suggested Reviewers
`@stanhu`, `@smcgivern`, `@tkuah`, `@mayra-cabrera`, `@marcel.amirault`

If you do not believe these suggestions are useful, please apply the label Bad Suggested Reviewer. You can also provide feedback for this feature on this issue: https://gitlab.com/gitlab-org/gitlab/-/issues/357923.

Automatically generated by Suggested Reviewers Bot - an experimental ML-based recommendation engine created by ~"group::applied ml".

added Technical Writing label

added devopsrelease [DEPRECATED] grouprelease [DEPRECATED] labels

added sectionops label

	1 Message
	This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge.

Documentation review

The following files require a review from a technical writer:

doc/user/packages/dependency_proxy/index.md
doc/user/packages/package_registry/index.md
doc/user/project/deploy_tokens/index.md

The review does not need to block merging this merge request. See the:

Metadata for the *.md files that you've changed. The first few lines of each *.md file identify the stage and group most closely associated with your docs change.
The Technical Writer assigned for that stage and group.
Documentation workflows for information on when to assign a merge request for review.

If needed, you can retry the danger-review job that generated this comment.

Generated by Danger

marked this merge request as draft

requested review from @jglassman1

added 1 commit

45f45d73 - Fix broken links

Compare with previous version

@jglassman1 - Could you please review this MR? I don't think it's worth doing a review build yet, so you can use the following link to preview the content: https://gitlab.com/gitlab-org/gitlab/-/blob/d4c7a907911adcc48851f66c0be1de05a856f011/doc/user/project/deploy_tokens/index.md

It's in draft status because I see room for improvement. It may be a little confusing, but this MR is related to !97905 (merged). The focus of this MR is to make the tasks CTRT compliant. The tasks are intermingled with other topic types, which I expect looks messy. When this and the related MR are merged, the result will be much cleaner.

You may notice several things:

The tasks are very light on detail.
Each task has an almost identical structure.
The useful commands (push, pull, and so on) are missing from the command examples.

As a result of this editing, I've realized it may be better to reformat this content into a table of "things you can do with a deploy token". The following structure may suit:

Function	Required scope	Example command
Pull image from container registry	`read_registry`	`docker login -u <username> -p <deploy_token> registry.example.com`

However, this creates a table where the example commands are wrapped, which makes it difficult to read. Do you have any ideas on how I could present this better?

added 1 commit

71170310 - Remove unwanted asterisk

Compare with previous version

removed review request for @jglassman1

added 1 commit

f4bedadb - Apply 6 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

206ec606 - Edit per review feedback

Compare with previous version

added 1 commit

137146fd - Improve troubleshooting entry

Compare with previous version

resolved all threads

added 1 commit

21c90c8f - Edit per self review

Compare with previous version

requested review from @jglassman1

@jglassman1 - Could you please review this MR again? I've addressed all your feedback since the previous review. I've also made several more changes in addition:

Reworded the introductions to the example commands so that it's clear they are examples, not prescribed commands.
Removed the screenshot of the deploy token's creation form. It didn't seem necessary, given it's a form, and the screenshot didn't help the instructions.
Moved mention of the scopes into the "Complete the fields." step. The scopes are one of the fields, so it didn't make sense to keep it separate.
Removed all instances of "For example, as part of a CI/CD pipeline." After reviewing this again, I decided that that's already described in the introduction, so it didn't make sense to repeat it each time.
Edited the single troubleshooting entry to comply with our CTRT format.

removed review request for @jglassman1

added 1 commit

4584ffcd - Apply 2 suggestion(s) to 1 file(s)

Compare with previous version

added 1 commit

5b20d88d - Edits per review feedback

Compare with previous version

requested review from @jglassman1

requested review from @kpaizee

@kpaizee - Could you please review this MR? Note that before merging this MR, I'll likely need to rebase it against master so that it contains all recent changes, including those from the related MR - !97905 (merged).