Skip to content

docs: clarify AWS Marketplace version - #828

Open
Creativeklvn wants to merge 1 commit into
Project-HAMi:masterfrom
Creativeklvn:aws-installation
Open

docs: clarify AWS Marketplace version#828
Creativeklvn wants to merge 1 commit into
Project-HAMi:masterfrom
Creativeklvn:aws-installation

Conversation

@Creativeklvn

@Creativeklvn Creativeklvn commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?
/kind documentation

What this PR does / why we need it:
Clarifies the AWS Marketplace version used in the installation instructions.

  • Specifies that the installation uses version 2.6.1-community.
  • Directs users to check the AWS Marketplace for the latest available version.

Which issue(s) this PR fixes:

Fixes #827

Checklist:

  • npm run lint and npm run format:check pass
  • npm run build succeeds for both en and zh
  • Chinese translation updated if English docs changed (or noted why not)
  • Commits are signed off (git commit -s)

Summary by CodeRabbit

  • Documentation
    • Updated the AWS installation guide to note availability through the AWS Marketplace.
    • Added installation options using Helm or the AWS add-on.
    • Documented the 2.6.1-community version and instructed users to check the AWS Marketplace listing for the latest version.

@hami-robot hami-robot Bot added the kind/documentation Improvements or additions to documentation label Aug 28, 2026
@hami-robot
hami-robot Bot requested review from rootsongjc and wawa0210 August 28, 2026 15:28
@hami-robot

hami-robot Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Creativeklvn
Once this PR has been reviewed and has the lgtm label, please assign windsonsea for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

@netlify

netlify Bot commented Aug 28, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 9763679
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a9e78456bbc710008260517
😎 Deploy Preview https://deploy-preview-828--project-hami.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.

@coderabbitai

coderabbitai Bot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: dfc3fb04-993a-4046-a08a-1b2a855ead20

📥 Commits

Reviewing files that changed from the base of the PR and between cd6d941 and 9763679.

📒 Files selected for processing (1)
  • docs/installation/aws-installation.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/installation/aws-installation.md

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


📝 Walkthrough

Walkthrough

The AWS installation guide now describes Helm and the AWS add-on as installation methods. It identifies version 2.6.1-community and links to the AWS Marketplace listing for the latest version.

Changes

AWS installation documentation

Layer / File(s) Summary
Update AWS installation version reference
docs/installation/aws-installation.md
The introduction describes Helm and the AWS add-on. A note identifies version 2.6.1-community and links to the AWS Marketplace listing for newer versions.

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

Merge Risk: ⚪ Minimal · up to 97636

This documentation update clarifies the AWS Marketplace version and directs users to newer releases; no current merge-readiness risk is identified.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The changes clarify that the guide uses version 2.6.1-community and direct users to check the AWS Marketplace for newer versions. The provided summary does not confirm that the required AWS Marketpl… Confirm that the AWS installation documentation includes a direct link to the AWS Marketplace listing. Add the link if it is absent.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the documentation change: clarifying the AWS Marketplace version reference.
Out of Scope Changes check ✅ Passed The pull request changes only the AWS installation documentation and stays within the scope of issue #827.
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…
Full details: Linked Issues check

Explanation

The changes clarify that the guide uses version 2.6.1-community and direct users to check the AWS Marketplace for newer versions. The provided summary does not confirm that the required AWS Marketplace listing hyperlink was added.

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

Comment thread docs/installation/aws-installation.md Outdated
HAMi is now available on the AWS Marketplace, and you can quickly install it via Helm or AWS add-on.
HAMi is now available on the AWS Marketplace and can be installed via Helm or the AWS add-on. The installation below uses version 2.6.1-community; for the latest available version, check the [AWS Marketplace listing](https://aws.amazon.com/marketplace/pp/prodview-x237accxbpuwa).

## Prerequisites

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.

this page has translated: true and a zh mirror under i18n/zh, which this pr does not touch. should the version note go there too?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don’t understand Chinese, so I wouldn’t be able to update the zh translation accurately. Would it be better to leave the Chinese mirror unchanged and have the translation updated separately?

Comment thread docs/installation/aws-installation.md Outdated
Signed-off-by: Kelvin Uneze <kelvinuneze@gmail.com>
@Creativeklvn

Copy link
Copy Markdown
Contributor Author

I have moved the version note under the Install with Helm heading since it only applies to the Helm installation and removed it from the introductory paragraph.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs kind/documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update AWS Installation Version Reference

2 participants