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

[AIRFLOW-XXX] Add how to run the docs server to docs #3704

Merged
merged 1 commit into from
Aug 6, 2018
Merged

[AIRFLOW-XXX] Add how to run the docs server to docs #3704

merged 1 commit into from
Aug 6, 2018

Conversation

tedmiston
Copy link
Contributor

Make sure you have checked all steps below.

Jira

  • My PR addresses the following Airflow Jira issues and references them in the PR title. For example, "[AIRFLOW-XXX] My Airflow PR"

Description

  • Here are some details about my PR, including screenshots of any UI changes:

I noticed that we already have a bash script to serve the docs site for local testing, however, it's not currently documented. This PR documents it.

Tests

  • My PR adds the following unit tests OR does not need testing for this extremely good reason:

only docs changes

Commits

  • My commits all reference Jira issues in their subject lines, and I have squashed multiple commits if they address the same issue. In addition, my commits follow the guidelines from "How to write a good git commit message":
    1. Subject is separated from body by a blank line
    2. Subject is limited to 50 characters (not including Jira issue reference)
    3. Subject does not end with a period
    4. Subject uses the imperative mood ("add", not "adding")
    5. Body wraps at 72 characters
    6. Body explains "what" and "why", not "how"

Documentation

  • In case of new functionality, my PR adds documentation that describes how to use it.
    • When adding new operators/hooks/sensors, the autoclass documentation generation needs to be added.

Code Quality

  • Passes git diff upstream/master -u -- "*.py" | flake8 --diff

@codecov-io
Copy link

Codecov Report

Merging #3704 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3704      +/-   ##
==========================================
- Coverage   77.56%   77.55%   -0.01%     
==========================================
  Files         204      204              
  Lines       15766    15766              
==========================================
- Hits        12229    12228       -1     
- Misses       3537     3538       +1
Impacted Files Coverage Δ
airflow/models.py 88.54% <0%> (-0.05%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dc64649...6915b40. Read the comment docs.

@kaxil
Copy link
Member

kaxil commented Aug 6, 2018

Thanks @tedmiston . Appreciate all the contributions for the docs. They are really important.

@kaxil kaxil merged commit 690df46 into apache:master Aug 6, 2018
@tedmiston tedmiston deleted the run-docs-server-docs branch August 6, 2018 15:04
lxneng pushed a commit to lxneng/incubator-airflow that referenced this pull request Aug 10, 2018
aliceabe pushed a commit to aliceabe/incubator-airflow that referenced this pull request Jan 3, 2019
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

3 participants