8000 Ensure consistency in project slug definition by kbatuigas · Pull Request #7543 · circleci/circleci-docs · GitHub
[go: up one dir, main page]

Skip to content
8000

Ensure consistency in project slug definition #7543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 10, 2022

Conversation

kbatuigas
Copy link
Contributor

Description

We recently made updates to the definition and guidelines around using "project slug" in API v2 for GitLab SaaS. This checks that other pages mentioning this API slug is consistent with the recent changes.

The Jira ticket associated with this PR was created earlier than the request to update the API docs, and it should have probably just been combined in the same ticket and PR, but I forgot to do so until too late. Sorry!

Reasons

See above

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸:

  • Break up walls of text by adding paragraph breaks.
  • Consider if the content could benefit from more structure, such as lists or tables, to make it easier to consume.
  • Keep the title between 20 and 70 characters.
  • Consider whether the content would benefit from more subsections (h2-h6 headings) to make it easier to consume.
  • Check all headings h1-h6 are in sentence case (only first letter is capitalized).
  • Is there a "Next steps" section at the end of the page giving the reader a clear path to what to read next?
  • Include relevant backlinks to other CircleCI docs/pages.

@kbatuigas kbatuigas requested a review from a team November 8, 2022 21:54
@kbatuigas kbatuigas merged commit ab95625 into master Nov 10, 2022
@devinmarieb devinmarieb deleted the DOCTEAM-738_project_slug_definition branch December 5, 2022 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0