Skip to content
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.

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

Add swagger links to docs #21

Open
kristinapathak opened this issue Sep 26, 2019 · 3 comments
Open

Add swagger links to docs #21

kristinapathak opened this issue Sep 26, 2019 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@kristinapathak
Copy link
Contributor

We may have the links somewhere, but I don't think so? We can either link the codex and xmidt/webpa swagger pages on their overview pages or add redirect pages to the left navigation under the correct projects.

@kristinapathak kristinapathak added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 26, 2019
@kristinapathak kristinapathak added the hacktoberfest good issue for hacktoberfest label Sep 30, 2019
@kristinapathak
Copy link
Contributor Author

swagger links:
https://swagger.webpa.comcast.net/
http://swagger.codex.comcast.net/

folders:
https://github.com/xmidt-org/docs/blob/master/content/docs/webpa/
https://github.com/xmidt-org/docs/blob/master/content/docs/codex/

I think adding a page in each folder called swagger.md that has metadata that redirects to the swagger pages would be perfect.

An example of the metadata:
https://github.com/xmidt-org/docs/blob/master/content/docs/codex/fenrir.md

For ordering in the navigation, I think the swagger docs should be right below the "overview" page.

@kristinapathak kristinapathak added the good first issue Good for newcomers label Oct 3, 2019
@kristinapathak kristinapathak removed the hacktoberfest good issue for hacktoberfest label Nov 1, 2019
@kristinapathak kristinapathak self-assigned this Nov 3, 2019
@kristinapathak
Copy link
Contributor Author

Codex done in #37

Still need to figure out the path forward for the XMiDT and WebPA swagger pages.

@joe94
Copy link
Member

joe94 commented Apr 6, 2020

Task: add opensource swagger page for webpa and xmidt (same style as codex's)

@kristinapathak kristinapathak removed their assignment May 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants