[jira] [Commented] (BEAM-12777) Stable URL for "current" API Documentation

["Brian Hulette (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/BEAM-12777?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17424635#comment-17424635 ] 

Brian Hulette commented on BEAM-12777:
--------------------------------------

Wanted to note here that once we make this change we can probably update a lot of the references to {{.Site.Params.release_latest }} in the website, and instead just point to "current"

> Stable URL for "current" API Documentation
> ------------------------------------------
>
>                 Key: BEAM-12777
>                 URL: https://issues.apache.org/jira/browse/BEAM-12777
>             Project: Beam
>          Issue Type: Improvement
>          Components: website
>            Reporter: Ahmet Altay
>            Priority: P2
>
> Discussion:  https://lists.apache.org/thread.html/rc23610839204f2bba1ea148885ef9f496a3087a47d7bb25662a46bc5%40%3Cdev.beam.apache.org%3E
> Summary of the proposal:
> """
> You may have noticed that our API Documentation could really use some SEO. It's possible to search for Beam APIs (e.g. "beam dataframe read_csv" [1] or "beam java ParquetIO" [2]) and you will be directed to some documentation, but it almost always takes you to an old version. I think this could be significantly improved if we just make one change: rather than making https://beam.apache.org/releases/javadoc/current redirect to the latest release, we should just always stage the latest documentation there.
> To be clear I'm not 100% sure this will help. I haven't talked to any search engineers or SEO experts about it. I'm just looking at other projects as a point of reference. I've found that I never have trouble finding the latest pandas documentation (e.g. "pandas read_csv" [3]) since it always directs to "pandas-docs/stable/" rather than a particular version number.
> We should also make sure the version number shows up in the page title, it looks like this isn't the case for Python right now.
> """



--
This message was sent by Atlassian Jira
(v8.3.4#803005)