Cross references and links

Cross references

Cross references (links between docs pages) in .adoc should be made in the following form:
```
link:/docs/github-integration#user-keys-and-deploy-keys[User Keys and Deploy Keys]
```

The .md equivalent would be to use a link:

[User Keys and Deploy Keys](/github-integration#user-keys-and-deploy-keys)

Cross references should explicitly name the document or section to which they are linking.
- Good: Refer to the Setting an environment variable in a project section of the Environment Variables document.
- Bad: See here for info on adding project-level environment variables.

Links

Links to third party sites should be in the following form in asciidoc content:
```
link:https://circleci.com[CircleCI]
```
The markdown link syntax is as follows:
```
[CircleCI](https://circleci.com)
```

Help make this document better

This guide, as well as the rest of our docs, are open source and available on GitHub. We welcome your contributions.

Suggest an edit to this page (please read the contributing guide first).
To report a problem in the documentation, or to submit feedback and comments, please open an issue on GitHub.
CircleCI is always seeking ways to improve your experience with our platform. If you would like to share feedback, please join our research community.

Need support?

Our support engineers are available to help with service issues, billing, or account related questions, and can help troubleshoot build configurations. Contact our support engineers by opening a ticket.

You can also visit our support site to find support articles, community forums, and training resources.

CircleCI Documentation by CircleCI is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.