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

Automate interactive API site generation and move to stacspec.org #434

Closed
2 of 3 tasks
cholmes opened this issue Apr 22, 2019 · 3 comments
Closed
2 of 3 tasks

Automate interactive API site generation and move to stacspec.org #434

cholmes opened this issue Apr 22, 2019 · 3 comments
Milestone

Comments

@cholmes
Copy link
Contributor

cholmes commented Apr 22, 2019

Right now our online interactive API docs live at swaggerhub, and must be updated manually. We should automate the process, and move the output to stacspec.org instead of swaggerhub.

  • Find right tooling to generate the API website from the openapi docs.
  • Migrate output to stacspec.org/api
  • Automate the build to automatically produce the website and deploy it to stacspec.org
@cholmes cholmes added this to the 0.7.0 milestone Apr 22, 2019
@cholmes cholmes changed the title Automative interactive API site generation and move to stacspec.org Automate interactive API site generation and move to stacspec.org May 2, 2019
@cholmes
Copy link
Contributor Author

cholmes commented May 2, 2019

Done! Using redoc, and now available on https://stacspec.org/STAC-api.html

Didn't actually need to use continuous integration, the tool picks up the open api docs direct from the repo with javascript

@cholmes cholmes closed this as completed May 2, 2019
@m-mohr m-mohr reopened this May 2, 2019
@m-mohr
Copy link
Collaborator

m-mohr commented May 2, 2019

Merging radiantearth/stac-site#19 needs to be done after the 0.7 release, therefore re-opened.

@cholmes
Copy link
Contributor Author

cholmes commented May 6, 2019

Closing, as radiantearth/stac-site#19 is merged.

@cholmes cholmes closed this as completed May 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants