Issues in Integration tutorials
Open
Nobody has claimed this yet.
API-M-4.0.0
API-M-Master
CEXP
help wanted
Priority/Highest
Type/Improvement
- Dominant language
- CSS
- Stars
- 99
- Forks
- 708
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 22
Description
Description
- Quick Start Guide link of What you'll build section is broken.
- In Develop the integration service doc, Step-6 mentioned the details about creating an endpoint artifact. Details about the type of endpoint that needs to be selected are missing in the table. Need to add the difference between the static and dynamic endpoint in this context to the table.
- In Develop the integration service doc, Step-7 is explaining the details about creating a REST API artifact. Details of VersionType and Path to Swagger Definition are missing in the table. (Even though they are not mandatory fields it is good to give an insight about those fields)
- In Develop the integration service doc, A screenshot need to be added to Step-8 for an easy access.
- This should be corrected as Deploy the MI-runtime in homepage
Affected Product Version
APIM 4.0.0
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Quick Start Guide, Service Catalog tutorial, and homepage pages. Check the broken link, update the Step-6 and Step-7 tables, add the Step-8 screenshot, and correct the homepage wording. Done means all five reported documentation issues are reflected in the rendered pages and the links work.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100