Skip to content

Hide draft content#496

Open
pcnfernando wants to merge 5 commits into
wso2:mainfrom
pcnfernando:doc-refac
Open

Hide draft content#496
pcnfernando wants to merge 5 commits into
wso2:mainfrom
pcnfernando:doc-refac

Conversation

@pcnfernando

@pcnfernando pcnfernando commented May 21, 2026

Copy link
Copy Markdown
Contributor

Purpose

Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.

Goals

Describe the solutions that this feature/fix will introduce to resolve the problems described above

Approach

Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter �N/A� plus brief explanation of why there�s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type �Sent� when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type �N/A� and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

Summary by CodeRabbit

  • Documentation

    • Marked several deployment guides as draft: AWS/Azure/GCP, Environments, GraalVM Native Images, Scaling & High Availability, and Serverless Deployment.
    • Simplified deployment prerequisites across Docker, Kubernetes, OpenShift, and Run Locally guides by removing technology-specific qualifiers.
  • Chores

    • Reorganized sidebar navigation in the Self-Hosted deployment section.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 21, 2026

Copy link
Copy Markdown
Contributor

Warning

Rate limit exceeded

@pcnfernando has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 41 minutes and 24 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c36e1dd5-7f5c-497a-a26e-6f713f926cb2

📥 Commits

Reviewing files that changed from the base of the PR and between 4bd641a and 5e8fff0.

📒 Files selected for processing (40)
  • en/docs/connectors/catalog/built-in/grpc/trigger-reference.md
  • en/docs/connectors/catalog/built-in/tcp/trigger-reference.md
  • en/docs/connectors/catalog/messaging/kafka/setup-guide.md
  • en/docs/deploy-operate/capacity-planning/overview.md
  • en/docs/deploy-operate/capacity-planning/performance-benchmarks.md
  • en/docs/deploy-operate/cicd/azure-devops.md
  • en/docs/deploy-operate/cicd/github-actions.md
  • en/docs/deploy-operate/cicd/gitlab.md
  • en/docs/deploy-operate/cicd/jenkins.md
  • en/docs/deploy-operate/observe/integration-control-plane-icp.md
  • en/docs/deploy-operate/observe/jaeger-distributed-tracing.md
  • en/docs/deploy-operate/observe/logging-overview.md
  • en/docs/deploy-operate/observe/metrics-overview.md
  • en/docs/deploy-operate/observe/moesif-api-analytics.md
  • en/docs/deploy-operate/observe/new-relic-integration.md
  • en/docs/deploy-operate/observe/observability-overview.md
  • en/docs/deploy-operate/observe/recipe-datadog-setup.md
  • en/docs/deploy-operate/observe/zipkin-tracing.md
  • en/docs/deploy-operate/secure/api-security-rate-limiting.md
  • en/docs/deploy-operate/secure/authentication.md
  • en/docs/deploy-operate/secure/compliance-considerations.md
  • en/docs/deploy-operate/secure/ip-whitelisting.md
  • en/docs/deploy-operate/secure/keystore-truststore.md
  • en/docs/deploy-operate/secure/runtime-security.md
  • en/docs/deploy-operate/secure/secrets-encryption.md
  • en/docs/deploy/overview.md
  • en/docs/deploy/self-hosted/docker.md
  • en/docs/deploy/self-hosted/kubernetes.md
  • en/docs/deploy/self-hosted/run-locally.md
  • en/docs/develop/integration-artifacts/file/high-availability-and-coordination.md
  • en/docs/develop/integration-artifacts/supporting/configurations.md
  • en/docs/develop/troubleshooting/logging.md
  • en/docs/develop/understand-ide/views/integration-view.md
  • en/docs/develop/understand-ide/views/project-view.md
  • en/docs/manage/icp/connect-runtime.md
  • en/docs/manage/icp/install-icp.md
  • en/docs/reference/appendix/faq.md
  • en/docs/reference/config/configuration-management.md
  • en/docusaurus.config.ts
  • en/sidebars.ts
📝 Walkthrough

Walkthrough

This PR restructures deployment documentation by marking five legacy deploy-operate guides as draft, standardizing prerequisites text in self-hosted guides by removing Ballerina-specific qualifiers, and updating sidebar navigation to reflect the organizational changes.

Changes

Deployment Documentation Restructuring

Layer / File(s) Summary
Mark legacy deploy-operate guides as draft
en/docs/deploy-operate/deploy/aws-azure-gcp.md, en/docs/deploy-operate/deploy/environments.md, en/docs/deploy-operate/deploy/graalvm-native-images.md, en/docs/deploy-operate/deploy/scaling-high-availability.md, en/docs/deploy-operate/deploy/serverless-deployment.md
Five legacy deployment guides are marked as draft using draft: true frontmatter, signaling their deprecated status.
Update self-hosted deployment prerequisites
en/docs/deploy/self-hosted/docker.md, en/docs/deploy/self-hosted/kubernetes.md, en/docs/deploy/self-hosted/openshift.md, en/docs/deploy/self-hosted/run-locally.md
Prerequisites text is standardized across self-hosted guides by removing "based on Ballerina" qualifier. OpenShift guide is also marked as draft.
Update sidebar navigation
en/sidebars.ts
The Deploy > Self-Hosted sidebar section is pruned, removing deprecated legacy entries and retaining only vm-based-deployment and managing-configurations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • wso2/docs-integrator#495: Updates the same Deploy > Self-Hosted sidebar section by managing legacy deploy-operate documentation entries.

Suggested reviewers

  • rosensilva
  • anupama-pathirage
  • KavinduZoysa
  • NipunaRanasinghe

Poem

🐰 Five guides now draft, their edges drawn bright,
Prerequisites simplified, no Ballerina in sight,
The sidebar grows lean, with wisdom to spare,
Self-hosted paths clearer for those who now care! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description contains only the template structure with no actual content filled in; all sections remain as placeholder text with no implementation details, rationale, or specific changes described. Fill in all required sections with actual information about why pages are being marked as draft, what the changes accomplish, and any relevant links or context for reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Hide draft content' is directly related to the main change: marking multiple documentation pages as draft and removing them from sidebars.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ 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.

Copilot AI left a comment

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.

Pull request overview

This PR aims to hide in-progress (“draft”) deployment documentation from the published navigation by removing several docs from the Deploy sidebar and marking the corresponding pages as drafts. It also standardizes prerequisite wording in the self-hosted deployment guides.

Changes:

  • Removed several deployment docs (OpenShift + multiple deploy-operate/deploy/* pages) from the Deploy sidebar.
  • Marked selected deployment pages as draft: true in frontmatter to hide them from publication.
  • Simplified prerequisites wording in self-hosted deployment docs (“A WSO2 Integrator project”).

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
en/sidebars.ts Removes draft/legacy deployment pages from the Deploy → Self-Hosted sidebar list.
en/docs/deploy/self-hosted/run-locally.md Updates prerequisites wording.
en/docs/deploy/self-hosted/docker.md Updates prerequisites wording.
en/docs/deploy/self-hosted/kubernetes.md Updates prerequisites wording.
en/docs/deploy/self-hosted/openshift.md Marks OpenShift page as draft and updates prerequisites wording.
en/docs/deploy-operate/deploy/serverless-deployment.md Marks serverless deployment page as draft.
en/docs/deploy-operate/deploy/aws-azure-gcp.md Marks cloud providers deployment page as draft.
en/docs/deploy-operate/deploy/graalvm-native-images.md Marks GraalVM native images page as draft.
en/docs/deploy-operate/deploy/environments.md Marks environments page as draft.
en/docs/deploy-operate/deploy/scaling-high-availability.md Marks scaling/HA page as draft.

Comment thread en/docs/deploy/self-hosted/openshift.md
Comment thread en/docs/deploy-operate/deploy/serverless-deployment.md
Comment thread en/docs/deploy-operate/deploy/aws-azure-gcp.md
Comment thread en/docs/deploy-operate/deploy/graalvm-native-images.md
Comment thread en/docs/deploy-operate/deploy/environments.md
Comment thread en/docs/deploy-operate/deploy/scaling-high-availability.md
Comment thread en/sidebars.ts
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