Skip to content

Add status documentation to the "Developer Starter Kit" section - #1067

Merged
gardener-prow[bot] merged 2 commits into
gardener:masterfrom
BoHristova:add-status-doc-to-developer-starter-kit
Aug 28, 2026
Merged

Add status documentation to the "Developer Starter Kit" section#1067
gardener-prow[bot] merged 2 commits into
gardener:masterfrom
BoHristova:add-status-doc-to-developer-starter-kit

Conversation

@BoHristova

@BoHristova BoHristova commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

How to categorize this PR?

/kind enhancement

What this PR does / why we need it:

The PR moves the recently created documentation for the status subresource to the Developer Starter Kit section, as it is relevant to all code contributions, not just those related to Gardener Core.

Special notes for your reviewer:
/cc @timuthy @marc1404

Summary by CodeRabbit

  • Documentation
    • Added a new “Status Subresource” topic to the developer starter kit documentation.
    • Reordered related documentation topics for improved navigation.
    • Excluded the new topic from the Gardener development documentation file tree.

Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
Signed-off-by: Bozhidara Hristova <bozhidara.hristova@sap.com>
@BoHristova
BoHristova requested a review from a team as a code owner August 28, 2026 13:05
@gardener-prow
gardener-prow Bot requested review from marc1404 and timuthy August 28, 2026 13:05
@gardener-prow gardener-prow Bot added the kind/enhancement Enhancement, improvement, extension label Aug 28, 2026
@netlify

netlify Bot commented Aug 28, 2026

Copy link
Copy Markdown

Deploy Preview for gardener-docs ready!

Name Link
🔨 Latest commit 813cc49
🔍 Latest deploy log https://app.netlify.com/projects/gardener-docs/deploys/6a91879056047f0008815f2b
😎 Deploy Preview https://deploy-preview-1067--gardener-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@gardener-prow gardener-prow Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Aug 28, 2026
@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro Plus

Run ID: 4a6e8ec3-5414-48cc-927d-95933524f5e3

📥 Commits

Reviewing files that changed from the base of the PR and between 96459c2 and 813cc49.

📒 Files selected for processing (1)
  • .docforge/contribute.yaml

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The documentation configuration adds status.md as the “Status Subresource” page, updates the weights of subsequent pages, and excludes the file from the Gardener development documentation file tree.

Changes

Documentation navigation

Layer / File(s) Summary
Add Status Subresource documentation
.docforge/contribute.yaml
Adds status.md with weight 90, shifts defaulting.md and validation-guidelines.md to weights 100 and 110, and excludes status.md from the Gardener development file tree.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 813cc

This PR only reorganizes documentation navigation to add the status page to the Developer Starter Kit, with no actionable merge-blocking risk remaining after normal checks and review.

Suggested reviewers: marc1404, timuthy

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: adding status documentation to the Developer Starter Kit section.
Description check ✅ Passed The description includes the PR category, purpose, rationale, and reviewer notes. The issue reference section is missing, but the description is otherwise complete and directly related to the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ 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.

@github-actions

Copy link
Copy Markdown
Contributor

Sitemap structure diff vs master

count
➕ added pages 0
➖ removed pages 0

First entries (full diff in the run summary & artifact):

ADDED   (0):
  (none)
REMOVED (0):
  (none)

A rename appears as one removed (old path) + one added (new path).

@marc1404 marc1404 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nice!

@gardener-prow

gardener-prow Bot commented Aug 28, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: marc1404

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gardener-prow gardener-prow Bot added lgtm Indicates that a PR is ready to be merged. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Aug 28, 2026
@gardener-prow

gardener-prow Bot commented Aug 28, 2026

Copy link
Copy Markdown

LGTM label has been added.

DetailsGit tree hash: edecc2fd0598aa7ad7e9e5f18c4ae12033e67c5b

@gardener-prow
gardener-prow Bot merged commit c711e26 into gardener:master Aug 28, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/enhancement Enhancement, improvement, extension lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants