[AIRFLOW-XXX] Improve the PubSub documentation

[TobKed]

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"
  • https://issues.apache.org/jira/browse/AIRFLOW-XXX
  • In case you are fixing a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue.
  • In case you are proposing a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
  • In case you are adding a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

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

Tests

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

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.
  • All the public functions and the classes in the PR contain docstrings that explain what it does
  • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

[TobKed]

this PR refers to review made on PolideaInternal#401
CC @mschickensoup @mik-laj

[TobKed]

CC @mik-laj @mschickensoup

[potiuk]

@mschickensoup .. does it have your approval :)?

[mschickensoup]

Let me re-phrase the description as well ;-) I've already done them, there's only one question reg. prepend in the JIRA section.

Make sure you have checked all steps below.

Jira

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

  • https://issues.apache.org/jira/browse/AIRFLOW-XXX
  • In case you fix a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue. || What did you mean by prepend was it supposed to be pretend?
  • In case you propose a fundamental code change, you need to create an Airflow Improvement Proposal (AIP).
  • If you add a dependency, check if the license complies with the ASF 3rd Party License Policy.

Description

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

Tests

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

Commits

• All of my commits reference to Jira issues in their subject lines. 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.

  • All the public functions and the classes in the PR contain docstrings that explain what it does
  • If you implement backwards incompatible changes, please leave a note in the Updating.md so we can assign it to a appropriate release

[TobKed]

In case you fix a typo in the documentation you can prepend your commit with [AIRFLOW-XXX], code changes always need a Jira issue. || What did you mean by prepend was it supposed to be pretend?

It means that commit should have [AIRFLOW-XXX] at the beginning of message. I think word prepend is correct here. Am I right @mschickensoup ?

[potiuk]

@mschickensoup -> the description is from template in https://github.com/apache/airflow/blob/master/.github/PULL_REQUEST_TEMPLATE.md - I think it needs some love and simplification... Maybe you can have YOUR first PR to improve it....