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

Update links to JSON:API documentation (community based media types) #1358

Closed
toedter opened this issue Sep 1, 2020 · 2 comments
Closed
Assignees
Labels
in: documentation Reference documentation in: mediatypes Media type related functionality
Milestone

Comments

@toedter
Copy link

toedter commented Sep 1, 2020

I had to restructure the JSON:API for Spring HATEOAS documentation, since I now publish documentation for all released versions as well as the current snapshot on the same gh-pages branch.

The new links for the (always) latest release are:
Reference Docs: https://toedter.github.io/spring-hateoas-jsonapi/release/reference/index.html
API Docs: https://toedter.github.io/spring-hateoas-jsonapi/release/api/index.html

The new links for the current snapshot version are:
Reference Docs: https://toedter.github.io/spring-hateoas-jsonapi/snapshot/reference/index.html
API Docs: https://toedter.github.io/spring-hateoas-jsonapi/snapshot/api/index.html

You could either link to the latest released version, or to both, released and snapshot.
I did not submit a pull request since it is your decision on what and how you link.

Probably a table would be nice (ignore empty header since GitHub cannot render Markdown tables without header), like

Latest Release Reference Docs. API Docs.
Current Snapshot Reference Docs. API Docs.

Thx

Kai

@toedter toedter changed the title Update links to JSON:API documentaion (community based media types) Update links to JSON:API documentation (community based media types) Sep 1, 2020
@gregturn gregturn self-assigned this Sep 2, 2020
@gregturn gregturn added in: documentation Reference documentation in: mediatypes Media type related functionality labels Sep 2, 2020
@gregturn gregturn added this to the 1.2 RC1 milestone Sep 2, 2020
@gregturn gregturn closed this as completed Sep 2, 2020
gregturn added a commit that referenced this issue Sep 2, 2020
@gregturn
Copy link
Contributor

gregturn commented Sep 2, 2020

Thanks @toedter !

@toedter
Copy link
Author

toedter commented Sep 2, 2020

That was quick! Thx @gregturn.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: documentation Reference documentation in: mediatypes Media type related functionality
Projects
None yet
Development

No branches or pull requests

2 participants