[GitHub] tedmiston opened a new pull request #3670: [AIRFLOW-2832] Lint and resolve inconsistencies in Markdown files

[GitBox <gi...@apache.org>]

tedmiston opened a new pull request #3670: [AIRFLOW-2832] Lint and resolve inconsistencies in Markdown files
URL: https://github.com/apache/incubator-airflow/pull/3670
 
 
   Make sure you have checked _all_ steps below.
   
   ### JIRA
   - [x] My PR addresses the following [Airflow JIRA](https://issues.apache.org/jira/browse/AIRFLOW/) issues and references them in the PR title. For example, "\[AIRFLOW-XXX\] My Airflow PR"
       - https://issues.apache.org/jira/browse/AIRFLOW-2832
       - 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.
   
   
   ### Description
   - [x] Here are some details about my PR, including screenshots of any UI changes:
   
   - Inspired by other recent issues related to linter errors in Python and JS (AIRFLOW-2783, AIRFLOW-2800, AIRFLOW-2803)
   - This PR does a few things:
     - Resolves linter errors in markdown files across the project (ignores errors that aren't super useful on GitHub such as line wrapping and putting `<urls>` in brackets)
     - Clarifies that commit message length of 50 characters doesn't include the Jira issue tag
     - Replaces usage of JIRA with Jira the way it's styled nowadays by [Atlassian](https://www.atlassian.com/software/jira) and [Wikipedia](https://en.wikipedia.org/wiki/Jira_(software))
     - Makes code block formatting consistent
   
   ### Tests
   - [x] My PR adds the following unit tests __OR__ does not need testing for this extremely good reason:
   
   The changes in this PR are restricted to linting documentation.
   
   ### Commits
   - [x] 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](http://chris.beams.io/posts/git-commit/)":
       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
   - [x] 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.
   
   n/a
   
   ### Code Quality
   - [x] Passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services