Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BEAM-4498] Sync javadoc and pydoc from apache/beam-site #6458

Closed
wants to merge 1 commit into from

Conversation

udim
Copy link
Member

@udim udim commented Sep 20, 2018

Migrates generated SDK documentation over to apache/beam on the asf-site branch.


Follow this checklist to help us incorporate your contribution quickly and easily:

  • Format the pull request title like [BEAM-XXX] Fixes bug in ApproximateQuantiles, where you replace BEAM-XXX with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

It will help us expedite review of your Pull Request if you tag someone (e.g. @username) to look at it.

Post-Commit Tests Status (on master branch)

Lang SDK Apex Dataflow Flink Gearpump Samza Spark
Go Build Status --- --- --- --- --- ---
Java Build Status Build Status Build Status Build Status Build Status Build Status Build Status
Python Build Status --- Build Status
Build Status
--- --- --- ---

@udim
Copy link
Member Author

udim commented Sep 21, 2018

R: @swegner

The flow as I see it:

  • Release script generates 2 PRs:
    • The first one generates pydoc and javadoc dirs (like this one), and is to be merged to branch asf-site.
    • The second updates website/documentation/sdks/javadoc/{index,current}.md, and is to be merge to branch master.
  • Post-commit process generates new files from the second PR and puts them in asf-site.
  • Apache website publishing process picks up changes from asf-site branch.

@tweise
Copy link
Contributor

tweise commented Sep 21, 2018

@swegner @udim are we not considering an alternative process that does not involve pulling all this into the repository?

@robertwb
Copy link
Contributor

Please don't check in 4 million lines of auto-generated docs into the main repository. (Is there a doc explaining what our plan is?)

Copy link
Contributor

@tweise tweise left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this requires more discussion before moving ahead.

@udim
Copy link
Member Author

udim commented Sep 21, 2018

@swegner
Copy link
Contributor

swegner commented Sep 21, 2018

@robertwb @tweise Let me restart the conversation on the dev@ list; this is a step in the implementation of the Beam-Site Automation Reliability work discussed here: https://s.apache.org/beam-site-automation.

As @udim mentioned we added a section to the doc for Concerns about generated content in apache/beam repository.

@udim
Copy link
Member Author

udim commented Sep 26, 2018

Abandoning, per discussion.

@udim udim closed this Sep 26, 2018
@udim udim deleted the website-sync branch September 26, 2018 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants