Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix rst code block format #34708

Merged
merged 2 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 21 additions & 18 deletions BREEZE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2553,9 +2553,10 @@ to add it to one of the providers, you need to add it to the ``provider.yaml`` f
directory - but remember that this should be followed by running pre-commit that will automatically update
the ``generated/provider_dependencies.json`` directory with the new dependencies:

```
pre-commit run update-providers-dependencies --all-files
```
.. code-block:: bash

pre-commit run update-providers-dependencies --all-files


You can also run the pre-commit by ``breeze static-checks --type update-providers-dependencies --all-files``
command - which provides autocomplete.
Expand All @@ -2565,17 +2566,18 @@ After you've updated the dependencies, you need to rebuild the image:
Breeze will automatically detect when you updated dependencies and it will propose you to build image next
time when you enter it. You can answer ``y`` during 10 seconds to get it done for you.

```
breeze ci-image build
```
.. code-block:: bash

breeze ci-image build


Sometimes, when you have conflicting change in dependencies (i.e. dependencies in the old constraints
are conflicting with the new specification, you might want to build the image with
``--upgrade-to-newer-dependencies`` flag:

```
breeze ci-image build --upgrade-to-newer-dependencies
```
.. code-block:: bash

breeze ci-image build --upgrade-to-newer-dependencies


System (debian) dependencies
Expand All @@ -2592,9 +2594,9 @@ other scripts (for example ``install_postgres.sh`` or ``install_mysql.sh``).

After you modify the dependencies in the scripts, you need to inline them by running pre-commit:

```
pre-commit run update-inlined-dockerfile-scripts --all-files
```
.. code-block:: bash

pre-commit run update-inlined-dockerfile-scripts --all-files

You can also run the pre-commit by ``breeze static-checks --type update-inlined-dockerfile-scripts --all-files``
command - which provides autocomplete.
Expand All @@ -2605,17 +2607,18 @@ After you've updated the dependencies, you need to rebuild the image:
Breeze will automatically detect when you updated dependencies and it will propose you to build image next
time when you enter it. You can answer ``y`` during 10 seconds to get it done for you.

```
breeze ci-image build
```
.. code-block:: bash

breeze ci-image build

Sometimes, when you have conflicting change in dependencies (i.e. dependencies in the old constraints
are conflicting with the new specification, you might want to build the image with
``--upgrade-to-newer-dependencies`` flag:

```
breeze ci-image build --upgrade-to-newer-dependencies
```
.. code-block:: bash

breeze ci-image build --upgrade-to-newer-dependencies


Node (yarn) dependencies
........................
Expand Down
18 changes: 9 additions & 9 deletions docs/apache-airflow/howto/docker-compose/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -310,18 +310,18 @@ you should do those steps:
``docker-compose.yaml`` file. The relevant part of the docker-compose file of yours should look similar
to (use correct image tag):

```
#image: ${AIRFLOW_IMAGE_NAME:-apache/airflow:2.6.1}
build: .
```
.. code-block:: docker

#image: ${AIRFLOW_IMAGE_NAME:-apache/airflow:2.6.1}
build: .

2) Create ``Dockerfile`` in the same folder your ``docker-compose.yaml`` file is with content similar to:

```
FROM apache/airflow:2.6.1
ADD requirements.txt .
RUN pip install apache-airflow==${AIRFLOW_VERSION} -r requirements.txt
```
.. code-block:: docker

FROM apache/airflow:2.6.1
ADD requirements.txt .
RUN pip install apache-airflow==${AIRFLOW_VERSION} -r requirements.txt

It is the best practice to install apache-airflow in the same version as the one that comes from the
original image. This way you can be sure that ``pip`` will not try to downgrade or upgrade apache
Expand Down
6 changes: 3 additions & 3 deletions docs/apache-airflow/security/webserver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,9 +313,9 @@ setting the ``RATELIMIT_*`` configuration settings in ``webserver_config.py``.
For example, to use Redis as a rate limit storage you can use the following configuration (you need
to set ``redis_host`` to your Redis instance)

```
RATELIMIT_STORAGE_URI = 'redis://redis_host:6379/0
```
.. code-block:: python

RATELIMIT_STORAGE_URI = "redis://redis_host:6379/0"

You can also configure other rate limit settings in ``webserver_config.py`` - for more details, see the
`Flask Limiter rate limit configuration <https://flask-limiter.readthedocs.io/en/stable/configuration.html>`_.
6 changes: 3 additions & 3 deletions docs/docker-stack/entrypoint.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ This can be achieved in various ways - you can change USER when you extend or cu
you can dynamically pass the user to ``docker run`` command, by adding ``--user`` flag in one of
those formats (See `Docker Run reference <https://docs.docker.com/engine/reference/run/#user>`_ for details):

```
[ user | user:group | uid | uid:gid | user:gid | uid:group ]
```
.. code-block:: text

[ user | user:group | uid | uid:gid | user:gid | uid:group ]

In case of Docker Compose environment it can be changed via ``user:`` entry in the ``docker-compose.yaml``.
See `Docker compose reference <https://docs.docker.com/compose/compose-file/compose-file-v3/#domainname-hostname-ipc-mac_address-privileged-read_only-shm_size-stdin_open-tty-user-working_dir>`_
Expand Down