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

Link to release (non-snapshot) API documentation from README and wiki #5629

Open
mernst opened this issue Jun 28, 2021 · 1 comment
Open
Assignees
Labels
P3 package=general type=documentation Documentation that is other than for an API

Comments

@mernst
Copy link
Contributor

mernst commented Jun 28, 2021

At https://guava.dev/releases/snapshot-jre/api/docs/ I typed "Parameter" into the search box at the upper right. See screenshot.

I clicked on the first match, which took me to
https://guava.dev/releases/snapshot-jre/api/docs/undefined/com/google/common/reflect/Parameter.html
which gave me a 404 error.

In addition to fixing this problem, I think it would be helpful to users to have a link to the stable (non-snapshot) API documentation, from both the README shown at https://github.com/google/guava and from https://github.com/google/guava/wiki .

@netdpb netdpb added P3 type=defect Bug, not working as expected labels Jun 28, 2021
@cpovirk
Copy link
Member

cpovirk commented Jun 29, 2021

Thanks. The search issue is #5457, which maybe we should fix by building Javadoc with a newer JDK.

Our approach for Javadoc has been to link to the Javadoc for a release from its page, e.g., https://github.com/google/guava/releases/tag/v30.1.1. Maybe @cgdecker has thoughts on whether to also include that on the landing page -- or maybe to link from the landing page's "Snapshots and Documentation" section to the Releases page?

@cpovirk cpovirk changed the title Documentation search box is broken Link to release (non-snapshot) API documentation from README and wiki Jun 29, 2021
@cpovirk cpovirk added package=general type=documentation Documentation that is other than for an API and removed type=defect Bug, not working as expected labels Jun 29, 2021
@cpovirk cpovirk assigned cgdecker and unassigned cpovirk Jun 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P3 package=general type=documentation Documentation that is other than for an API
Projects
None yet
Development

No branches or pull requests

4 participants