-
Notifications
You must be signed in to change notification settings - Fork 551
Fix issue 4623-Master: update links from 4.4.x to 4.6.x #10527
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix issue 4623-Master: update links from 4.4.x to 4.6.x #10527
Conversation
WalkthroughDocumentation 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
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. Comment |
There was a problem hiding this 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
📒 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
59be09c to
50ba000
Compare
There was a problem hiding this 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
📒 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.
Purpose
Documentation
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.