Skip to content

Conversation

@BechtelCanDoIt
Copy link
Contributor

@BechtelCanDoIt BechtelCanDoIt commented Jan 6, 2026

Purpose

Update documentation links from 4.4.x to 4.6.x.

Documentation

https://apim.docs.wso2.com/en/latest/install-and-setup/install/installation-options/

Summary by CodeRabbit

  • Documentation
    • Updated installation guide links to reference the latest stable version (4.6.x) for Kubernetes (Helm), Docker/Docker Compose, and Puppet deployment methods to ensure users follow current instructions.
    • Reorganized the Installation Options section into a dedicated subsection with clearer, indented entries for each deployment method to improve navigation and readability.

✏️ Tip: You can customize this high-level summary in your review settings.

@CLAassistant
Copy link

CLAassistant commented Jan 6, 2026

CLA assistant check
All committers have signed the CLA.

@coderabbitai
Copy link

coderabbitai bot commented Jan 6, 2026

Walkthrough

Documentation update that reorganizes the Installation Options section into a dedicated subsection with three indented items (Kubernetes (Helm), Docker/Docker Compose, Puppet) and updates external guide links from version 4.4.x to 4.6.x.

Changes

Cohort / File(s) Summary
Documentation Update
en/docs/install-and-setup/install/installation-options.md
Replaced top-level list with an "Installation Options" subsection containing indented items for Kubernetes (Helm), Docker/Docker Compose, and Puppet; updated external guide links from 4.4.x to 4.6.x for all three methods.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop through the docs, tidy and slick,
Links bumped to 4.6 with a cheerful kick,
Sections aligned in a neat little stack,
Install paths now clearer — forward we hop back! 🥕

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. It only provides Purpose and Documentation sections but omits most required template sections (Goals, Approach, User stories, Release note, Training, Certification, Marketing, Tests, Security, Samples, Related PRs, Migrations, Test environment, Learning). Complete the pull request description by filling in the remaining required template sections, particularly Goals, Approach, Release note, and Test environment to provide comprehensive context for reviewers.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title clearly summarizes the main change: updating documentation links from version 4.4.x to 4.6.x, which directly matches the file changes.
✨ Finishing touches
  • 📝 Generate docstrings

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

@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: 0

🧹 Nitpick comments (1)
en/docs/install-and-setup/install/installation-options.md (1)

12-12: Consider replacing "in order to" with "to" for conciseness.

The phrases "in order to deploy" can be simplified to "to deploy" for more concise technical documentation.

🔎 Proposed style improvements
- You can follow the guides available in [https://github.com/wso2/helm-apim](https://github.com/wso2/helm-apim/tree/4.6.x) in order to deploy API Manager Helm artifacts.
+ You can follow the guides available in [https://github.com/wso2/helm-apim](https://github.com/wso2/helm-apim/tree/4.6.x) to deploy API Manager Helm artifacts.
- You can follow the guides available in [https://github.com/wso2/docker-apim](https://github.com/wso2/docker-apim/tree/4.6.x) in order to deploy API Manager Docker artifacts.
+ You can follow the guides available in [https://github.com/wso2/docker-apim](https://github.com/wso2/docker-apim/tree/4.6.x) to deploy API Manager Docker artifacts.
- You can follow the guides available in [https://github.com/wso2/puppet-apim](https://github.com/wso2/puppet-apim/tree/4.6.x) in order to deploy API Manager using Puppet artifacts.
+ You can follow the guides available in [https://github.com/wso2/puppet-apim](https://github.com/wso2/puppet-apim/tree/4.6.x) to deploy API Manager using Puppet artifacts.

Also applies to: 16-16, 20-20

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e4e2670 and 59be09c.

📒 Files selected for processing (1)
  • en/docs/install-and-setup/install/installation-options.md
🧰 Additional context used
🪛 LanguageTool
en/docs/install-and-setup/install/installation-options.md

[style] ~12-~12: Consider a more concise word here.
Context: ...//github.com/wso2/helm-apim/tree/4.6.x) in order to deploy API Manager Helm artifacts. ## ...

(IN_ORDER_TO_PREMIUM)


[style] ~16-~16: Consider a more concise word here.
Context: ...github.com/wso2/docker-apim/tree/4.6.x) in order to deploy API Manager Docker artifacts. #...

(IN_ORDER_TO_PREMIUM)


[style] ~20-~20: Consider a more concise word here.
Context: ...github.com/wso2/puppet-apim/tree/4.6.x) in order to deploy API Manager using Puppet artifac...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (2)
en/docs/install-and-setup/install/installation-options.md (2)

5-8: Table of contents structure looks good.

The reorganization into a dedicated subsection with proper markdown link anchors follows documentation best practices.


12-12: Version links correctly updated from 4.4.x to 4.6.x.

All three installation method guides (Kubernetes, Docker, Puppet) have been updated consistently and the URL formats are correct.

Also applies to: 16-16, 20-20

@BechtelCanDoIt BechtelCanDoIt force-pushed the fixing-issue-4623-main branch from 59be09c to 50ba000 Compare January 6, 2026 09:12
Copy link

@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: 0

🧹 Nitpick comments (1)
en/docs/install-and-setup/install/installation-options.md (1)

12-12: Version links updated correctly; consider minor style polish.

The external guide links have been successfully updated from 4.4.x to 4.6.x across all three installation methods, which aligns with the PR objective. The changes are consistent and correctly formatted.

Optional refinement: For improved readability, consider replacing "in order to" with "to" on all three lines. This makes the sentences more concise without losing meaning.

🔎 Optional style improvement (conciseness)
- You can follow the guides available in [https://github.com/wso2/helm-apim](https://github.com/wso2/helm-apim/tree/4.6.x) in order to deploy API Manager Helm artifacts.
+ You can follow the guides available in [https://github.com/wso2/helm-apim](https://github.com/wso2/helm-apim/tree/4.6.x) to deploy API Manager Helm artifacts.

- You can follow the guides available in [https://github.com/wso2/docker-apim](https://github.com/wso2/docker-apim/tree/4.6.x) in order to deploy API Manager Docker artifacts.
+ You can follow the guides available in [https://github.com/wso2/docker-apim](https://github.com/wso2/docker-apim/tree/4.6.x) to deploy API Manager Docker artifacts.

- You can follow the guides available in [https://github.com/wso2/puppet-apim](https://github.com/wso2/puppet-apim/tree/4.6.x) in order to deploy API Manager using Puppet artifacts.
+ You can follow the guides available in [https://github.com/wso2/puppet-apim](https://github.com/wso2/puppet-apim/tree/4.6.x) to deploy API Manager using Puppet artifacts.

Also applies to: 16-16, 20-20

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 59be09c and 50ba000.

📒 Files selected for processing (1)
  • en/docs/install-and-setup/install/installation-options.md
🧰 Additional context used
🪛 LanguageTool
en/docs/install-and-setup/install/installation-options.md

[style] ~12-~12: Consider a more concise word here.
Context: ...//github.com/wso2/helm-apim/tree/4.6.x) in order to deploy API Manager Helm artifacts. ## ...

(IN_ORDER_TO_PREMIUM)


[style] ~16-~16: Consider a more concise word here.
Context: ...github.com/wso2/docker-apim/tree/4.6.x) in order to deploy API Manager Docker artifacts. #...

(IN_ORDER_TO_PREMIUM)


[style] ~20-~20: Consider a more concise word here.
Context: ...github.com/wso2/puppet-apim/tree/4.6.x) in order to deploy API Manager using Puppet artifac...

(IN_ORDER_TO_PREMIUM)

🔇 Additional comments (1)
en/docs/install-and-setup/install/installation-options.md (1)

5-8: Good improvement to the documentation structure.

The addition of the table of contents (TOC) with indented links improves navigation and makes the document structure more scannable. This follows Markdown documentation best practices.

@BechtelCanDoIt BechtelCanDoIt changed the title Fix issue 4623: update links from 4.4.x to 4.6.x Fix issue 4623-Master: update links from 4.4.x to 4.6.x Jan 6, 2026
@tharikaGitHub tharikaGitHub merged commit 9c2f37b into wso2:master Jan 14, 2026
2 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.

3 participants