You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by po...@apache.org on 2022/09/15 12:52:19 UTC
[airflow] branch main updated: update contributing documentations (#26411)
This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 983993c44d update contributing documentations (#26411)
983993c44d is described below
commit 983993c44dbe2f7768b33c7d1606b74aaeddca52
Author: Wei Lee <we...@gmail.com>
AuthorDate: Thu Sep 15 20:52:10 2022 +0800
update contributing documentations (#26411)
* CONTRIBUTING.rst: replace markdown style link as rst style
* CONTRIBUTORS_QUICK_START.rst
* unify python version in examples to 3.8 (originally, the first example uses 3.7 which
could break the setup flow)
* fix testing command typo
---
CONTRIBUTING.rst | 4 ++--
CONTRIBUTORS_QUICK_START.rst | 8 ++++----
2 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 7c80c76555..faff694d46 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1203,10 +1203,10 @@ commands:
React, JSX and Chakra
-----------------------------
-In order to create a more modern UI, we have started to include [React](https://reactjs.org/) in the ``airflow/www/`` project.
+In order to create a more modern UI, we have started to include `React <https://reactjs.org/>`__ in the ``airflow/www/`` project.
If you are unfamiliar with React then it is recommended to check out their documentation to understand components and jsx syntax.
-We are using [Chakra UI](https://chakra-ui.com/) as a component and styling library. Notably, all styling is done in a theme file or
+We are using `Chakra UI <https://chakra-ui.com/>`__ as a component and styling library. Notably, all styling is done in a theme file or
inline when defining a component. There are a few shorthand style props like ``px`` instead of ``padding-right, padding-left``.
To make this work, all Chakra styling and css styling are completely separate. It is best to think of the React components as a separate app
that lives inside of the main app.
diff --git a/CONTRIBUTORS_QUICK_START.rst b/CONTRIBUTORS_QUICK_START.rst
index 2526d7b87f..4537016127 100644
--- a/CONTRIBUTORS_QUICK_START.rst
+++ b/CONTRIBUTORS_QUICK_START.rst
@@ -224,7 +224,7 @@ Setting up Breeze
.. code-block:: bash
- $ breeze --python 3.7 --backend postgres
+ $ breeze --python 3.8 --backend postgres
.. note::
If you encounter an error like "docker.credentials.errors.InitializationError:
@@ -612,7 +612,7 @@ All Tests are inside ./tests directory.
.. code-block:: bash
- $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset --test-type All tests
+ $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset testing tests --test-type All
- Running specific type of test
@@ -622,7 +622,7 @@ All Tests are inside ./tests directory.
.. code-block:: bash
- $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset --test-type Core
+ $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset testing tests --test-type Core
- Running Integration test for specific test type
@@ -631,7 +631,7 @@ All Tests are inside ./tests directory.
.. code-block:: bash
- $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset --test-type All --integration mongo
+ $ breeze --backend postgres --postgres-version 10 --python 3.8 --db-reset testing tests --test-type All --integration mongo
- For more information on Testing visit : |TESTING.rst|