[
https://issues.apache.org/jira/browse/BEAM-12777?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17456717#comment-17456717
]
Brian Hulette commented on BEAM-12777:
--------------------------------------
The docs are hosted in the release-docs branch of apache/beam-site:
https://github.com/apache/beam-site/tree/release-docs
Publishing new release docs is part of the release process, documented here
https://beam.apache.org/contribute/release-guide/#propose-pull-requests-for-website-updates
There's a build_release_candidate.sh script that actually generates the docs:
https://github.com/apache/beam/blob/118bbc9e947206c321674a042cc2739581f1a4b3/release/src/main/scripts/build_release_candidate.sh#L354-L372
> 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
> Assignee: Mike Hernandez
> 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.20.1#820001)
