This makes a lot of sense to me.
On Thu, Jun 17, 2021 at 9:03 AM Brian Hulette <[email protected]> wrote: > > Hi everyone, > 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. > > Would there be any objections to making this change? > > Also are there thoughts on how to make the change? Presumably this is > something we'd have to update in the release process. > > Thanks, > Brian > > [1] > https://beam.apache.org/releases/pydoc/2.25.0/apache_beam.dataframe.io.html > [2] > https://beam.apache.org/releases/javadoc/2.5.0/org/apache/beam/sdk/io/parquet/ParquetIO.html > [3] > https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html
