Skip to content

chore: Moving sample models into docs folder#118

Merged
jland-redhat merged 6 commits intomainfrom
samples-to-root
Oct 2, 2025
Merged

chore: Moving sample models into docs folder#118
jland-redhat merged 6 commits intomainfrom
samples-to-root

Conversation

@jland-redhat
Copy link
Copy Markdown
Contributor

@jland-redhat jland-redhat commented Oct 1, 2025

Moved the sample models to the root directory. And simplified the readme

Summary by CodeRabbit

  • Documentation

    • Consolidated and reorganized sample model deployment docs; added a clearer samples guide with deployment steps and environment-variable usage and updated README links to point to the new samples location.
    • Removed an outdated duplicate sample models document.
  • Bug Fixes

    • Fixed malformed YAML list entry in RBAC kustomization to ensure correct parsing during deployments.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Oct 1, 2025

Walkthrough

Documentation reorganization: moved the sample models README from deployment/samples/models to docs/samples/models, updated the top-level README's sample link to the new path, removed the deployment-specific README, and fixed a malformed YAML list item in docs/samples/models/rbac/kustomization.yaml. No code or control-flow changes.

Changes

Cohort / File(s) Summary
Docs relocation and README update
README.md, deployment/samples/models/README.md, docs/samples/models/README.md
Updated top-level README.md link from deployment/samples/models/ to docs/samples/models/; removed deployment/samples/models/README.md; added docs/samples/models/README.md with deployment instructions using MODEL_NAME and kustomize/kubectl.
RBAC kustomize YAML fix
docs/samples/models/rbac/kustomization.yaml
Corrected malformed YAML list item from -- all-tiers.yaml to - all-tiers.yaml to ensure valid kustomize parsing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my ears and hop through docs tonight,
Old folders hush as new pages take flight.
A dash to a dot, YAML tidy and bright,
I stash the links and nibble bytes polite,
Then bound to samples in the moon’s soft light. 🐇✨

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 succinctly captures the primary refactoring in this changeset—relocating the sample model documentation into the docs directory—and aligns with the updated links and file removals in deployment/samples/models. It is clear, specific, and concise, enabling reviewers to understand the main purpose without extraneous detail. There is no misleading or unrelated content in the title.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch samples-to-root

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e191d5b and 1095314.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • docs/samples/models/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/samples/models/README.md
  • README.md

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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between efc1616 and a2be5a4.

📒 Files selected for processing (5)
  • README.md (1 hunks)
  • demo-models/README.md (1 hunks)
  • deployment/samples/models/README.md (0 hunks)
  • deployment/samples/models/rbac/all-tiers.yaml (0 hunks)
  • deployment/samples/models/rbac/kustomization.yaml (0 hunks)
💤 Files with no reviewable changes (3)
  • deployment/samples/models/rbac/all-tiers.yaml
  • deployment/samples/models/rbac/kustomization.yaml
  • deployment/samples/models/README.md
🔇 Additional comments (1)
demo-models/README.md (1)

1-11: Docs match the relocated demos.

The instructions align with the new root-level directory and give clear deploy steps.

README.md Outdated
- Open an issue on GitHub
- Check the [deployment guide](deployment/README.md) for troubleshooting
- Review the [samples](deployment/samples/models/) for examples
- Review the [samples](samples/models/) for examples
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Broken link after directory move.

The new path samples/models/ doesn’t exist after relocating the demo assets; the directory is now demo-models/, so this link 404s. Please update the href (and link text if desired) to point at the new location.

-- Review the [samples](samples/models/) for examples
+- Review the [demo models](demo-models/) for examples
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- Review the [samples](samples/models/) for examples
Review the [demo models](demo-models/) for examples
🤖 Prompt for AI Agents
In README.md around line 211, the link points to the removed path
samples/models/ causing a 404; update the href to demo-models/ (and optionally
change link text to "demo-models") so the link points to the relocated
directory, ensuring any relative path context is preserved.

Copy link
Copy Markdown
Collaborator

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

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

I wonder if putting those models under top-level docs/samples/models wouldn't help in organizing user-facing content and examples?

I also think that without rbac/ piece, which this PR removes, we can't use AuthPolicy (and subsequent (token)rate limiting) for these models, they're accessible for everyone.

Copy link
Copy Markdown
Collaborator

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

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

Couple of nits in the docs - namely, relative paths alignment

@jland-redhat jland-redhat changed the title Moving demo models to the root directory chore: Moving sample models into docs folder Oct 2, 2025
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
jland-redhat and others added 2 commits October 2, 2025 09:52
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
Copy link
Copy Markdown
Collaborator

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
Collaborator

@dmytro-zaharnytskyi dmytro-zaharnytskyi left a comment

Choose a reason for hiding this comment

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

Don't like idea putting models under docs/ dir, (seems confusing) but anyway, all changes lead to the greater good :))

@jland-redhat jland-redhat merged commit 2ab48e5 into main Oct 2, 2025
2 checks passed
@bartoszmajsak bartoszmajsak deleted the samples-to-root branch October 3, 2025 09:14
SB159 pushed a commit to SB159/maas-billing that referenced this pull request Oct 15, 2025
* Moving demo models to the root directory

* Adding back in rbac

* Moving to docs/samples/models

* Update docs/samples/models/README.md

Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>

* Update docs/samples/models/README.md

Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>

* Addressing comment

---------

Co-authored-by: Jamie Land <hokie10@gmail.com>
Co-authored-by: Bartosz Majsak <bartosz.majsak@gmail.com>
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.

4 participants