Skip to content

Commit bac5569

Browse files
committed
Improvements of AGENTS.md
Assisted-by: gemini-3-pro-preview
1 parent e8ab7ab commit bac5569

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ There are other adjacent procedures described or linked in the repo that are opt
3434

3535
- There should be parity between the docs and the tests. There may be some legitimate minor differences to account for CI specifics, but in general the intent of the tests is to verify the procedure and the commands from the docs.
3636
- Tests use the `shell` Ansible module liberally, we do not strive for "beautiful Ansible that just uses Python modules". Using `shell` tends to allow verbatim correspondence of tests to the commands/snippets in the docs, which is more important than having beautiful Ansible code.
37+
- Docs must support multiple variants (upstream/downstream/OSPDO). Do not hardcode product names like "Red Hat OpenStack Services on OpenShift". Use the AsciiDoctor attributes defined in `docs_user/adoption-attributes.adoc` (e.g. `{rhos_long}`, `{OpenStackShort}`).
3738

3839
## Important
3940

@@ -42,8 +43,9 @@ There are other adjacent procedures described or linked in the repo that are opt
4243

4344
## Repository map
4445

45-
- `docs_build/adoption-dev/index-upstream.html` - Rendered developer documentation.
46-
- `docs_build/adoption-user/index-{upstream,downstream,downstream-ospdo}.html` - Rendered user documentation (the adoption procedure).
46+
- `docs_build` - Generated content. Do not read or edit files in this directory as a source of truth. Always use `docs_user` or `docs_dev`.
47+
- `docs_build/adoption-dev/index-upstream.html` - Rendered developer documentation.
48+
- `docs_build/adoption-user/index-{upstream,downstream,downstream-ospdo}.html` - Rendered user documentation (the adoption procedure).
4749
- `docs_dev` - Sources for developer documentation.
4850
- `docs_user` - Sources for user documentation (the adoption procedure).
4951
- `main.adoc` is the root.

0 commit comments

Comments
 (0)