Skip to content

Track reference.adoc for website generation#24

Merged
robnester-rh merged 1 commit intoconforma:mainfrom
robnester-rh:EC-1686-fixup
Mar 23, 2026
Merged

Track reference.adoc for website generation#24
robnester-rh merged 1 commit intoconforma:mainfrom
robnester-rh:EC-1686-fixup

Conversation

@robnester-rh
Copy link
Copy Markdown
Contributor

@robnester-rh robnester-rh commented Mar 23, 2026

Summary

Remove reference.adoc from .gitignore so it can be tracked in git. This allows the website build (Antora) to pull the file from the repository and include it in the documentation site.

Previously, reference.adoc was incorrectly added to .gitignore when the crds structure was extracted from enterprise-contract-controller. This meant the file was never committed, and Antora couldn't access it when building the website documentation.

Changes

  • Remove docs/modules/ROOT/pages/reference.adoc from .gitignore
  • Add the generated reference.adoc file to version control

Test Plan

  • CI passes (make all generates docs, git diff checks for uncommitted changes)
  • Website rebuild picks up the reference documentation

Ref: EC-1686

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 06ed6a77-bb4b-4b96-be44-c463aea82143

📥 Commits

Reviewing files that changed from the base of the PR and between f1a6f86 and fa906fa.

📒 Files selected for processing (2)
  • .gitignore
  • docs/modules/ROOT/pages/reference.adoc
💤 Files with no reviewable changes (1)
  • .gitignore
✅ Files skipped from review due to trivial changes (1)
  • docs/modules/ROOT/pages/reference.adoc

📝 Walkthrough

Walkthrough

The pull request removes a .gitignore rule that previously excluded a generated documentation file and adds the corresponding AsciiDoc API reference documentation for Kubernetes resource types (EnterpriseContractPolicy, EnterpriseContractPolicyList) and associated schema definitions.

Changes

Cohort / File(s) Summary
Build Configuration
.gitignore
Removed ignore pattern for docs/modules/ROOT/pages/reference.adoc to allow the generated documentation file to be tracked in version control.
API Documentation
docs/modules/ROOT/pages/reference.adoc
Added generated AsciiDoc API reference documentation with schema definitions for Kubernetes resource types, including field descriptions for EnterpriseContractPolicy, spec/status types, and nested configuration structures.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: tracking the reference.adoc file for website generation by removing it from .gitignore.
Description check ✅ Passed The description is directly related to the changeset, explaining why the .gitignore rule was removed and the reference.adoc file was added, with clear context about the previous issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Remove reference.adoc from .gitignore so it can be tracked in git.
This allows the website build (Antora) to pull the file from the
repository and include it in the documentation site.

Ref: EC-1686

Signed-off-by: Rob Nester <rnester@redhat.com>
Made-with: Cursor
@robnester-rh robnester-rh changed the title Fix docs generation and tracking Track reference.adoc for website generation Mar 23, 2026
Copy link
Copy Markdown

@dheerajodha dheerajodha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@robnester-rh robnester-rh merged commit d526a78 into conforma:main Mar 23, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants