Commit 6a1d4da5 authored by Mike Jang's avatar Mike Jang

Merge branch 'docs-api-changelog-style-guide' into 'master'

Move changelog notes to the correct guides

See merge request gitlab-org/gitlab!45973
parents 8c20d3fd 4855adaa
...@@ -1446,3 +1446,7 @@ For information on generating GraphQL documentation and schema files, see ...@@ -1446,3 +1446,7 @@ For information on generating GraphQL documentation and schema files, see
To help our readers, you should also add a new page to our [GraphQL API](../api/graphql/index.md) documentation. To help our readers, you should also add a new page to our [GraphQL API](../api/graphql/index.md) documentation.
For guidance, see the [GraphQL API](documentation/graphql_styleguide.md) page. For guidance, see the [GraphQL API](documentation/graphql_styleguide.md) page.
## Include a changelog entry
All client-facing changes **must** include a [changelog entry](changelog.md).
...@@ -292,3 +292,8 @@ expect(response).to match_response_schema('merge_requests') ...@@ -292,3 +292,8 @@ expect(response).to match_response_schema('merge_requests')
``` ```
Also see [verifying N+1 performance](#verifying-with-tests) in tests. Also see [verifying N+1 performance](#verifying-with-tests) in tests.
## Include a changelog entry
All client-facing changes **must** include a [changelog entry](changelog.md).
This does not include internal APIs.
...@@ -90,7 +90,3 @@ Be aware that CI tests for that second MR will fail with a bad link until the ...@@ -90,7 +90,3 @@ Be aware that CI tests for that second MR will fail with a bad link until the
main MR that adds the new GraphQL page is merged. Therefore, only merge the MR against the main MR that adds the new GraphQL page is merged. Therefore, only merge the MR against the
[`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) repository after the content has [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) repository after the content has
been merged and live on `docs.gitlab.com`. been merged and live on `docs.gitlab.com`.
## Include a changelog entry
All client-facing changes **must** include a [changelog entry](../changelog.md).
...@@ -178,8 +178,3 @@ do something like this: ...@@ -178,8 +178,3 @@ do something like this:
```shell ```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "skip_users[]=<user_id>" --data "skip_users[]=<user_id>" "https://gitlab.example.com/api/v4/projects/<project_id>/users" curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "skip_users[]=<user_id>" --data "skip_users[]=<user_id>" "https://gitlab.example.com/api/v4/projects/<project_id>/users"
``` ```
## Include a changelog entry
All client-facing changes **must** include a [changelog entry](../changelog.md).
This does not include internal APIs.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment