airflow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (AIRFLOW-2832) Inconsistencies and linter errors across markdown files
Date Wed, 01 Aug 2018 07:50:00 GMT

    [ https://issues.apache.org/jira/browse/AIRFLOW-2832?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16564907#comment-16564907
] 

ASF GitHub Bot commented on AIRFLOW-2832:
-----------------------------------------

Fokko commented on a change in pull request #3670: [AIRFLOW-2832] Lint and resolve inconsistencies
in Markdown files
URL: https://github.com/apache/incubator-airflow/pull/3670#discussion_r206783822
 
 

 ##########
 File path: dev/README.md
 ##########
 @@ -72,25 +76,33 @@ origin	https://github.com/<USER>/airflow (push)
 ```
 
 #### JIRA
+
 Users should set environment variables `JIRA_USERNAME` and `JIRA_PASSWORD` corresponding
to their ASF JIRA login. This will allow the tool to automatically close issues. If they are
not set, the user will be prompted every time.
 
 #### GitHub OAuth Token
+
 Unauthenticated users can only make 60 requests/hour to the Github API. If you get an error
about exceeding the rate, you will need to set a `GITHUB_OAUTH_KEY` environment variable that
contains a token value. Users can generate tokens from their GitHub profile.
 
 ## Airflow release signing tool
+
 The release signing tool can be used to create the SHA512/MD5 and ASC files that required
for Apache releases.
 
 ### Execution
-To create a release tar ball execute following command from Airflow's root. 
 
-`python setup.py compile_assets sdist --formats=gztar`
+To create a release tarball execute following command from Airflow's root.
 
-*Note: `compile_assets` command build the frontend assets (JS and CSS) files for the 
+```bash
+python setup.py compile_assets sdist --formats=gztar
+```
+
+*Note: `compile_assets` command build the frontend assets (JS and CSS) files for the
 Web UI using webpack and npm. Please make sure you have `npm` installed on your local machine
globally.
 Details on how to install `npm` can be found in CONTRIBUTING.md file.*
 
 After that navigate to relative directory i.e., `cd dist` and sign the release files.
 
-`../dev/sign.sh <the_created_tar_ball.tar.gz` 
+```bash
+../dev/sign.sh <the_created_tar_ball.tar.gz
 
 Review comment:
   If I would go fully nitpick mode, I would ask you to add a space after the `<`

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


> Inconsistencies and linter errors across markdown files
> -------------------------------------------------------
>
>                 Key: AIRFLOW-2832
>                 URL: https://issues.apache.org/jira/browse/AIRFLOW-2832
>             Project: Apache Airflow
>          Issue Type: Improvement
>          Components: docs, Documentation
>            Reporter: Taylor Edmiston
>            Assignee: Taylor Edmiston
>            Priority: Minor
>
> There are a number of inconsistencies within and across markdown files in the Airflow
project.  Most of these are simple formatting issues easily fixed by linting (e.g., with
mdl).



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message