[jira] [Updated] (BEAM-4510) Release-based Javadocs and Pydocs should be generated during the website build

["David Huntsperger (Jira)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/BEAM-4510?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

David Huntsperger updated BEAM-4510:
------------------------------------
    Fix Version/s: Not applicable
       Resolution: Not A Problem
           Status: Resolved  (was: Open)

> Release-based Javadocs and Pydocs should be generated during the website build
> ------------------------------------------------------------------------------
>
>                 Key: BEAM-4510
>                 URL: https://issues.apache.org/jira/browse/BEAM-4510
>             Project: Beam
>          Issue Type: Improvement
>          Components: website
>            Reporter: Scott Wegner
>            Priority: P3
>             Fix For: Not applicable
>
>
> Currently, Javadocs and Pydocs are generated manually as a [step during the release process|https://beam.apache.org/contribute/release-guide/#propose-a-pull-request-for-website-updates] and [checked into|https://github.com/apache/beam-site/tree/asf-site/src/documentation/sdks] the apache/beam-site repository. The [Beam-Site Automation Reliability|https://s.apache.org/beam-site-automation] project proposes a set of work to migrate the website sources into the apache/beam repository, but doesn't address changes to the process for generating Javadocs / Pydocs.
> It would be nice if the API documentation could also generated as part of the website HTML generation process, such that it automatically stays up-to-date and removes a manual step from the release process.
> This is following up on [discussion|https://docs.google.com/a/google.com/document/d/1lfbMhdIyDzIaBTgc9OUByhSwR94kfOzS_ozwKWTVl5U/edit?disco=AAAAB50kLV4] from the [Beam-Site Automation Reliability|https://s.apache.org/beam-site-automation] project design.



--
This message was sent by Atlassian Jira
(v8.20.1#820001)