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

Adding API doc links to OMERO docs front page #749

Merged
merged 1 commit into from Apr 30, 2014
Merged

Conversation

hflynn
Copy link
Member

@hflynn hflynn commented Apr 22, 2014

See https://www.openmicroscopy.org/community/viewtopic.php?f=6&t=7423&p=13878 for context - we had a request to make the generated API docs easier to find.

@mtbc
Copy link
Member

mtbc commented Apr 23, 2014

Strange they go to the Ice 3.3 one, not 3.4 at least, but that's a separate issue: this PR's good to merge.

@sbesson
Copy link
Member

sbesson commented Apr 23, 2014

My only comment on this PR is that these ext links point at the CI job. Is it time to alias the latest API (like latest downloads) and use these?

/cc @qidane

@hflynn hflynn added the dev_5_0 label Apr 24, 2014
@hflynn
Copy link
Member Author

hflynn commented Apr 29, 2014

Aren't developers likely to want non-release versions at least some of the time?

@sbesson
Copy link
Member

sbesson commented Apr 29, 2014

I guess this depends on what we mean by developers. If we mean internal OME developers, these links are definitely useful. For external developers, I would be inclined to point at the released API as much as possible (just like we point at the release downloads instead of the CI artifacts). Not a blocker for this PR to be merged but definitely a starting point for a broader discussion.

@hflynn
Copy link
Member Author

hflynn commented Apr 30, 2014

Ok, I'll merge this and rebase and add that question to the API docs card on Trello for further discussion. The link is set in the config anyway so I wouldn't need to change this file again to update it.

hflynn added a commit that referenced this pull request Apr 30, 2014
Adding API doc links to OMERO docs front page
@hflynn hflynn merged commit 77b98f4 into ome:dev_5_0 Apr 30, 2014
@hflynn
Copy link
Member Author

hflynn commented Apr 30, 2014

--rebased-to #758

@hflynn hflynn deleted the api-links branch May 29, 2014 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants