Commit db556981 authored by Suzanne Selhorn's avatar Suzanne Selhorn Committed by Evan Read

Docs: Updated fake URL guidance

Because we don't formally call out the fake domain names we use
parent 9d09f38b
......@@ -1616,6 +1616,13 @@ and email address of a user. Don't use real user information in API calls:
- **Names**: Use strings like `Example Username`. Alternatively, use diverse or non-gendered names with
common surnames, such as `Sidney Jones`, `Zhang Wei`. or `Maria Garcia`.
### Fake URLs
When including sample URLs in the documentation, use:
- `example.com` when the domain name is generic.
- `gitlab.example.com` when referring to self-managed instances of GitLab.
### Fake tokens
There may be times where a token is needed to demonstrate an API call using
......
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