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

Promote new flags in ./docs/build_docs.py #12991

Merged
merged 4 commits into from
Dec 10, 2020

Conversation

mik-laj
Copy link
Member

@mik-laj mik-laj commented Dec 10, 2020

Not everyone is aware that we have divided the documentation and now it is possible to build documentation for only one package, which is much faster. I am adding messages encouraging them to take advantage of these options to let more people know about it.

I also hope to reduce the number of failed builds on CI if users can quickly test their changes locally. Previously, building documentation took too long for anyone to want to do it locally.

Sample message from a user who was unaware of this flag.

I gave up on building the doc locally as it seems to take a really long, so I create the PR first to see if it can go through the CI. I will build it locally again if it's necessary. Do you have any tips on speeding up the building process? (edited)

https://apache-airflow.slack.com/archives/CJ1LVREHX/p1607063305069700

CC: @xinbinhuang


^ Add meaningful description above

Read the Pull Request Guidelines for more information.
In case of fundamental code change, Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in UPDATING.md.

@mik-laj mik-laj requested a review from kaxil December 10, 2020 19:24
@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Dec 10, 2020
@github-actions
Copy link

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.

Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

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

❤️ ❤️ ❤️ ❤️ ❤️ ❤️ ❤️ ❤️

@mik-laj mik-laj merged commit 5752821 into apache:master Dec 10, 2020
@mik-laj mik-laj deleted the promote-new-flags branch December 10, 2020 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation okay to merge It's ok to merge this PR as it does not require more tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants