wso2 / wso2/docs-apim

Inconsitent diagrams and documentation between different patterns

Open
#9,362 0 comments 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

Below doc link has multiple deployment patterns for API Manager, however the diagrams are inconsistent from one another. Also some patterns doesnt have the information to configure on VMs. Appreciate if this can be corrected

https://apim.docs.wso2.com/en/latest/install-and-setup/setup/deployment-overview/

Steps to Reproduce

None

Version

4.5.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 deployment overview page linked in the issue and compare the diagrams for each deployment pattern. Identify patterns whose diagrams differ in equivalent concepts and those missing VM configuration guidance. Done means the diagrams are consistent and every applicable pattern includes the required VM setup information.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.