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-2509] Separate config docs into how-to guides #3400

Closed
wants to merge 1 commit into from

Conversation

tswast
Copy link
Contributor

@tswast tswast commented May 22, 2018

Also moves how-to style instructions for logging from "integration" page
to a "Writing Logs" how-to.

Make sure you have checked all steps below.

JIRA

Description

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

Splits Configuration documentation into separate how-to guides, much as the Django documentation does.

image

Tests

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

No tests. Docs-only change.

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
    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.

Docs-only change.

Code Quality

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

Also moves how-to style instructions for logging from "integration" page
to a "Writing Logs" how-to.
@tswast
Copy link
Contributor Author

tswast commented May 22, 2018

Travis failure appears to be unrelated to this change (permissions error on installing a package).

Copy link
Contributor

@Fokko Fokko 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 is a good improvement. +1

Copy link
Member

@kaxil kaxil left a comment

Choose a reason for hiding this comment

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

LGTM

@kaxil
Copy link
Member

kaxil commented May 23, 2018

Thank you @tswast for this PR. The documentation changes are always very important. Appreciate that.

@asfgit asfgit closed this in 084bc91 May 23, 2018
@kaxil
Copy link
Member

kaxil commented May 23, 2018

@tswast Can you update the documentation here to say that you can also create connections using the Airflow Web UI which is much easy and intuitive as compared to environment variables method and also point to the specific link of creating connection (see here ) instead of linking it to the concepts section?

Or instead of 2 separate pages i.e 1) Securing connections, and 2) Creating connections: I think a single page Creating and Securing connections would make more sense.

What do you think about it @tswast?

@tswast
Copy link
Contributor Author

tswast commented May 23, 2018

@kaxil Yes, updating the connection page is the next thing I want to work on. Web UI instructions are a good idea.

I actually would like to have space to talk about all the specific connection types on the creating a connection page. The PostgreSQL example you link to would be a good one to add. Selfishly, I'd also like to document how to create a GCP connection soon, too.

It could make sense to combine the creating and securing pages, but securing them felt like a very different task from creating one, which is why I split them up.

aliceabe pushed a commit to aliceabe/incubator-airflow that referenced this pull request Jan 3, 2019
Also moves how-to style instructions for logging
from "integration" page
to a "Writing Logs" how-to.

Closes apache#3400 from tswast/howto
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