Skip to content

Add an example trailer to changelog API docs

Kaitlyn Chappell requested to merge docs-add-trailer-example into master

What does this MR do?

The changelog API documentation does a great job of showing how to use the endpoint itself and customize the generated changelog file. However while we mention you have to use a specific Git trailer and link to the Git documentation for those, it's unclear that you can simply add the trailer to the end of your commit message to include the commit in the changelog.

A customer wrote in confused about what the trailer had to be and how to use it, and while looking through the documentation myself I was equally confused. Neither of us had used Git trailers much before, and we agreed a small commit message example showing how to add your trailer to the message would have got us on the right track a little faster!

Related issues

Here's the (internal only) Zendesk ticket where you can see the customer and I figure it out together: https://gitlab.zendesk.com/agent/tickets/204251

We ended up looking at this feedback issue to clarify a lot of our confusion: gitlab-com/gl-infra/delivery#1546 (closed)

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Kaitlyn Chappell

Merge request reports

Loading