wso2 / wso2/docs-apim

Issues in CI/CD for APIs docs

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

Nobody has claimed this yet.

API-M-4.0.0 API-M-Master help wanted Priority/High Type/Bug
Dominant language
CSS
Stars
99
Forks
708
Avg merge
1d 7h
Merged PRs (30d)
22

Description

Description

Due to the following issues, first-time users of this scenario will need to search a lot and figure out the concerns on their own

Doc link: https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/ci-cd-with-wso2-api-management/#page-header

  1. The Heading repeated twice or it is not properly formatted.
    Screenshot from 2021-05-10 09-15-48

  2. Building a CI/CD Pipeline for APIs using the Jenkins link is not directing to the correct doc. It should be routed to https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/building-jenkins-ci-cd-pipeline-for-dev-first-approach/
    Screenshot from 2021-05-10 09-16-41

Doc Link : https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/building-jenkins-ci-cd-pipeline-for-dev-first-approach/#step-1-write-the-openapi-specification-and-test-scripts

  1. Screenshots of https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/building-jenkins-ci-cd-pipeline-for-dev-first-approach/#prerequisites section need to be updated

  2. To perform step-4 of https://apim.docs.wso2.com/en/latest/install-and-setup/setup/api-controller/building-jenkins-ci-cd-pipeline-for-dev-first-approach/#step-6-trigger-jenkins-pipeline we need to install the Jenkins plugin to the local Jenkins server. If not the pipeline option will not display in the jobs and that will confuse the user.
    Screenshot from 2021-05-10 16-44-38

  3. Add more images in the flow for better usability.
    eg:
    Screenshot from 2021-05-10 17-46-48

  4. We can remove the console outputs screenshots and provide them as text as it is a bit long

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 two linked API Controller documentation pages and compare the repeated heading, Jenkins link, prerequisite screenshots, and pipeline instructions. Check that the Jenkins plugin requirement and additional flow images are covered, and replace the long console-output screenshots with text where requested. Done means the links, formatting, screenshots, and user guidance are corrected on both pages.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.