odh-33627: add new topic on configuring model catalog source files

[smccarthy-ie]

HTML preview:

• https://opendatahub-documentation--1047.org.readthedocs.build/en/1047/working-with-model-registries/index.html#configuring-model-catalog-sources-in-openshift_model-registry

Summary by CodeRabbit

• Documentation
  • Added a new procedure for configuring model catalog sources in OpenShift, including prerequisites, step-by-step configuration, required fields, sample catalog examples, verification steps in the OpenShift AI dashboard, and links to additional resources.

[coderabbitai]

Walkthrough

Documentation for configuring model catalog sources in OpenShift is added: a new procedure module is created and included in the working-with-the-model-catalog assembly. The module describes prerequisites, editing the model-catalog-sources ConfigMap, required fields, sample configs, and verification steps.

Changes

Cohort / File(s)	Summary
Documentation - Model Catalog Configuration assemblies/working-with-the-model-catalog.adoc, modules/configuring-model-catalog-sources-in-openshift.adoc	Assembly file adds an include for the new module. New module adds an OpenShift PROCEDURE covering prerequisites, steps to edit the model-catalog-sources ConfigMap, required fields (name, id, type, properties.yamlCatalogPath, labels), sample catalog entries, verification in the OpenShift AI dashboard, and links to related resources.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Pay attention to correctness of the ConfigMap fields and sample YAML in modules/configuring-model-catalog-sources-in-openshift.adoc.
• Verify the include path in assemblies/working-with-the-model-catalog.adoc matches the new module file location.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly reflects the main change: adding a new documentation topic on configuring model catalog source files, which matches the changeset that adds the new module and includes it in the assembly.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4b677dc and 208381e.

📒 Files selected for processing (1)

• modules/configuring-model-catalog-sources-in-openshift.adoc (1 hunks)

🔇 Additional comments (3)

modules/configuring-model-catalog-sources-in-openshift.adoc (3)

10-13: Prerequisites are clear and well-structured.

---

54-58: Verification steps are clear and well-structured.

---

60-61: Additional resources link is relevant and well-formatted.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91b5ee1 and 4b677dc.

📒 Files selected for processing (2)

• assemblies/working-with-the-model-catalog.adoc (1 hunks)
• modules/configuring-model-catalog-sources-in-openshift.adoc (1 hunks)

🔇 Additional comments (4)

modules/configuring-model-catalog-sources-in-openshift.adoc (3)

1-13: Well-structured prerequisites and introduction.

The module header, abstract, and prerequisites are clear and appropriately scoped.

---

54-58: Clear and actionable verification steps.

The verification section effectively guides users on how to confirm their configuration in the OpenShift AI dashboard, with appropriate conditional guidance for labeled vs. unlabeled catalogs.

---

60-61: Verify and clean up external link formatting.

The additional resources section provides a useful reference link. Please verify that the GitHub URL is current and check for any trailing whitespace after the closing bracket on line 61 (AsciiDoc is sensitive to formatting).

assemblies/working-with-the-model-catalog.adoc (1)

11-11: Correct include directive placement and syntax.

The new include is properly formatted and logically positioned within the assembly. The leveloffset matches existing includes for consistency.

[dbasunag]

I feel, this implies that the changes are reflected immediately. That is however, is not the case, it can take a few minutes for the changes to be reflected. To make it immediately reflect, one has to kill the catalog pod and let it get re-spinned.