You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2021/02/04 05:19:07 UTC

[GitHub] [airflow] leahecole opened a new pull request #14062: Small docs readme update

leahecole opened a new pull request #14062:
URL: https://github.com/apache/airflow/pull/14062


   Added a small update to the docs README after I found running docs locally to not be intuitive (building instructions are great though!! 😄 ) (thanks @rachael-ds for rescuing me) 


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] kaxil commented on a change in pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #14062:
URL: https://github.com/apache/airflow/pull/14062#discussion_r570156828



##########
File path: docs/README.rst
##########
@@ -56,6 +56,17 @@ or just to run documentation building
 .. code-block:: bash
 
      ./breeze build-docs -- --docs-only
+     
+Running the Docs Locally
+------------------------
+
+Once you have built the documentation run the following command from the root directory:
+
+.. code-block:: bash
+    
+    docs/start_doc_server.sh

Review comment:
       ```suggestion
   .. code-block:: bash
   
       docs/start_doc_server.sh
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] github-actions[bot] commented on pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14062:
URL: https://github.com/apache/airflow/pull/14062#issuecomment-773099761






----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] kaxil commented on a change in pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
kaxil commented on a change in pull request #14062:
URL: https://github.com/apache/airflow/pull/14062#discussion_r570156828



##########
File path: docs/README.rst
##########
@@ -56,6 +56,17 @@ or just to run documentation building
 .. code-block:: bash
 
      ./breeze build-docs -- --docs-only
+     
+Running the Docs Locally
+------------------------
+
+Once you have built the documentation run the following command from the root directory:
+
+.. code-block:: bash
+    
+    docs/start_doc_server.sh

Review comment:
       ```suggestion
   .. code-block:: bash
   
       docs/start_doc_server.sh
   ```




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] github-actions[bot] commented on pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14062:
URL: https://github.com/apache/airflow/pull/14062#issuecomment-773549641


   The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest master or amend the last commit of the PR, and push it with --force-with-lease.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] leahecole merged pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
leahecole merged pull request #14062:
URL: https://github.com/apache/airflow/pull/14062


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] leahecole merged pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
leahecole merged pull request #14062:
URL: https://github.com/apache/airflow/pull/14062


   


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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



[GitHub] [airflow] github-actions[bot] commented on pull request #14062: Small docs readme update

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #14062:
URL: https://github.com/apache/airflow/pull/14062#issuecomment-773099761


   [The Workflow run](https://github.com/apache/airflow/actions/runs/536402776) is cancelling this PR. It has some failed jobs matching ^Pylint$,^Static checks,^Build docs$,^Spell check docs$,^Backport packages$,^Provider packages,^Checks: Helm tests$,^Test OpenAPI*.


----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to 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