Skip to content

build: deploy API documentation #245

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
Open
Totktonada opened this issue Nov 19, 2019 · 0 comments
Open

build: deploy API documentation #245

Totktonada opened this issue Nov 19, 2019 · 0 comments
Labels
backlog code health Improve code readability, simplify maintenance and so on documentation Improvements or additions to documentation prio1

Comments

@Totktonada
Copy link
Member

Totktonada commented Nov 19, 2019 •
edited
Loading

It seems https://tarantool.github.io/tarantool-java/ it the proper place for the API documentation (now I see outdated API docs are on http://tarantool.github.io/tarantool-java/apidocs/index.html ; but I don't know to reach them from the previous link).

I think we should perform deploy manually as part of the release process (or even store separate documentation for each release) to don't confuse users with not-released-yet changes.

Maybe connected with #244.
@Totktonada Totktonada added documentation Improvements or additions to documentation code health Improve code readability, simplify maintenance and so on labels Nov 19, 2019
@Totktonada Totktonada mentioned this issue Dec 1, 2019
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
backlog code health Improve code readability, simplify maintenance and so on documentation Improvements or additions to documentation prio1
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Totktonada @TarantoolBot