|
| 1 | +# AGENTS.md for CockroachDB docs |
| 2 | + |
| 3 | +Hello! We're working together on docs for CockroachDB, a distributed SQL database. The docs are located in Markdown files (with Liquid templates) in various subdirectories of this one. |
| 4 | + |
| 5 | +This file has instructions and general info for working with us on these docs. Please pay close attention to things written here. |
| 6 | + |
| 7 | +Docs for each released version are in subdirectories named for the version, e.g., `v25.4`. |
| 8 | + |
| 9 | +Docs specific to the CockroachDB Cloud product are in `cockroachcloud`. |
| 10 | + |
| 11 | +Docs related to release notes and other release-related matters are in `releases`. |
| 12 | + |
| 13 | +## Style guide |
| 14 | + |
| 15 | +Our style guide lives in `StyleGuide.md` in the root of this repository. Please follow the guidance there carefully when writing docs. |
| 16 | + |
| 17 | +## Include files |
| 18 | + |
| 19 | +To avoid repeating text across different files, we use shared "include files" (or just: "includes") which are referenced using the following syntax. |
| 20 | + |
| 21 | +For includes that apply across versions or products: |
| 22 | + |
| 23 | +``` |
| 24 | +{% include common/define-watched-cdc.md %} |
| 25 | +``` |
| 26 | + |
| 27 | +For includes that pertain to the CockroachDB Cloud product: |
| 28 | + |
| 29 | +``` |
| 30 | +{% include cockroachcloud/metrics-time-interval-selection.md %} |
| 31 | +``` |
| 32 | + |
| 33 | +For includes that we can assume only apply to specific versions, though in some cases, their content may be identical across all versions where the file exists: |
| 34 | + |
| 35 | +``` |
| 36 | +{% include vXX.Y/misc/cert-auth-using-x509-subject.md %} |
| 37 | +``` |
| 38 | + |
| 39 | +Note: The Liquid variable `{{page.version.version}}` resolves to the major version in the path of the page where it is used (e.g. `v25.4`). References to version-specific includes often use this, allowing the same page content that's used across versions to show different versions of an include, based on the current version being rendered. For example, `{% include {{page.version.version}}/misc/cert-auth-using-x509-subject.md %}`. |
| 40 | + |
| 41 | +The includes are all located in subdirectories of the `_include` directory, i.e., |
| 42 | + |
| 43 | +- `_include/common` for widely shared things |
| 44 | +- `_include/cockroachcloud` for Cloud |
| 45 | +- `_include/v25.4` for v25.4-specific content |
| 46 | + |
| 47 | +<!-- eof --> |
0 commit comments