wso2 / wso2/docs-apim

Update Health Check docs for APIM versions from 4.6.0 and below

Open Beginner friendly
#11,550 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

The doc[1] should be updated. Under Step 1 - Deploy the Health Checker we ask to fork the github repository and build it with mvn clean install. We need to specifically mention the user to checkout to tag v1.3.3 and build it.

This change should be done to all versions from APIM 4.6.0 and below.

[1] https://apim.docs.wso2.com/en/4.6.0/administer/logging-and-monitoring/monitoring/monitoring-server-health/

Steps to Reproduce
Version

4.6.0

Environment Details (with versions)

No response

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked Health Checker documentation page and the “Step 1 - Deploy the Health Checker” section. Check how the APIM 4.6.0-and-earlier versioned pages are organized, then update each applicable page to mention checking out tag v1.3.3 before running mvn clean install; done means all versions from 4.6.0 and below contain the instruction.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
documentation, observability
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.