wso2 / wso2/docs-apim

Check the consistency of topics and instructions under 'Install and Setup'

Open
#3,985 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API-M-4.0.0 Docs/TW Type/Improvement
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Since we have a lot of sections duplicated for API-M runtime, MI runtime, and Streaming runtime, need to check if all the instructions and topics are presented in a consistent way even though the content is duplicated.

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

Locate the duplicated sections under “Install and Setup” for the API-M, MI, and Streaming runtimes. Compare their topics, ordering, and instructions to identify inconsistencies, then verify that the three sections present equivalent guidance consistently.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.