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

Consider using github.io to document reference docs #49

Open

displague opened this issue Nov 28, 2022 · 2 comments

Labels

Member

displague commented Nov 28, 2022 •

edited

Loading

Today, the reference docs for this project can be found in https://github.com/equinix-labs/metal-java/blob/main/equinix-openapi-metal/README.md

Consider using github.io to document java docs, similar to https://packethost.github.io/packet-java/.

Member Author

displague commented Oct 4, 2023

This seems to be the most popular action that bundles the necessary steps, leaning on https://github.com/marketplace/actions/deploy-to-github-pages

https://github.com/marketplace/actions/deploy-publish-javadoc

displague added the documentation label

displague changed the title ~~Consider using github.io to document java docs~~ Consider using github.io to document reference docs

Member Author

displague commented Oct 4, 2023

An alternative approach may be to identify a home in developers.equinix.com or deploy.equinix.com (somewhere in /developers)

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