You can link to current, I believe:
https://beam.apache.org/releases/javadoc/current/org/apache/beam/sdk/io/FileSystems.html


On Wed, May 6, 2020 at 12:13 PM Robert Bradshaw <[email protected]> wrote:

> On Wed, May 6, 2020 at 11:15 AM Chamikara Jayalath <[email protected]>
> wrote:
> >
> > Can't we use something like the "{{ site.release_latest }}" tag used in
> Website docs ?
> >
> https://github.com/apache/beam/blob/master/website/src/get-started/quickstart-java.md
>
> +1. It would be good to have a solution that works everywhere, e.g.
> for links sent out to mailing lists, on StackOverflow, etc. (Yes, I
> realize there's value in having links that are pinned to specific
> versions/points in time, but most of the time a user is best served by
> looking at the latest documentation, with the ability to *easily*
> toggle to a specific version.)
>
> > On Wed, May 6, 2020 at 11:06 AM Robert Bradshaw <[email protected]>
> wrote:
> >>
> >> E.g. if I google "apache beam javadoc", the first link is for version
> >> 2.1.0 (no, that's not 2.21.0), the second for a (raw-looking)
> >> directory index of javadocs by version, the third for Beam 2.5.0, and
> >> the fourth for a class in 2.2.0.
> >>
> >>
> >> On Wed, May 6, 2020 at 11:02 AM Robert Bradshaw <[email protected]>
> wrote:
> >> >
> >> > One problem is that there's no way to link to the "latest" version of
> >> > the docs, or toggle between them. What links to docs we have are
> >> > pointing to specific (often very old or out of date) docs. If we can
> >> > solve this that'd make me more in favor of this proposal.
> >> >
> >> > On Wed, May 6, 2020 at 9:23 AM Kenneth Knowles <[email protected]>
> wrote:
> >> > >
> >> > > +1
> >> > >
> >> > > On Wed, May 6, 2020 at 9:11 AM Alexey Romanenko <
> [email protected]> wrote:
> >> > >>
> >> > >> +1 It would make more sense to point to the latest release Javadoc
> of IO
> >> > >>
> >> > >> On 6 May 2020, at 06:56, Chamikara Jayalath <[email protected]>
> wrote:
> >> > >>
> >> > >> +1 for linking to the more readable version.
> >> > >>
> >> > >> - Cham
> >> > >>
> >> > >> On Tue, May 5, 2020, 9:26 AM Brian Hulette <[email protected]>
> wrote:
> >> > >>>
> >> > >>> +1 for doc links instead of code. I think from a user perspective
> the code link is effectively the same as javadoc/pydoc since they'll just
> peruse the docstrings, except it's harder to read and reflects the behavior
> at HEAD, not at any release.
> >> > >>>
> >> > >>> Brian
> >> > >>>
> >> > >>> On Mon, May 4, 2020 at 6:21 PM Pablo Estrada <[email protected]>
> wrote:
> >> > >>>>
> >> > >>>> Hi all,
> >> > >>>> I just noted that in our Built-in IOs page[1], we tend to link
> to the code for the IOs that we mention.
> >> > >>>>
> >> > >>>> I think it would be better to link to the Javadoc or the Pydoc
> for those IOs instead. Thoughts?
> >> > >>>> Best
> >> > >>>> -P.
> >> > >>>>
> >> > >>>> [1] https://beam.apache.org/documentation/io/built-in/
> >> > >>
> >> > >>
>

Reply via email to