New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish API Documentation to GitHub Pages #485

Open

jackjia-ibm opened this issue May 16, 2019 · 1 comment

Labels

CI/CD

Member

jackjia-ibm commented May 16, 2019 •

edited

Loading

We want to update pipeline to have a new step to publish documentation to GitHub Pages after release.

The final documentation may look like https://zowe.github.io/jobs, for Jobs Explorer API.

Scope of repositories:

jobs
data-sets
(Pending...)

The options to generate html docs:

https://github.com/Rebilly/ReDoc can convert swagger.xml to html
http://readthedocs.org/
https://swagger.io/tools/open-source/open-source-integrations/

Open questions:

How do we versioning the documentation.

jackjia-ibm added the CI/CD label

Contributor

jordanCain commented Aug 20, 2019

The swagger doc for the ZSS APIs exposed via zLUX can be found here https://github.com/zowe/zlux-app-server/tree/master/doc/swagger

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment