Skip to content

Commit

Permalink
Fix links in documentation (#23975)
Browse files Browse the repository at this point in the history
* fix links
* added right link to breeze
  • Loading branch information
edithturn committed May 28, 2022
1 parent af23a01 commit 33eef7b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
2 changes: 1 addition & 1 deletion BREEZE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Here is an example configuration with more than 200GB disk space for Docker:
Docker Compose
--------------

- **Version**: Install the latest stable `Docker Compose<https://docs.docker.com/compose/install/>`_
- **Version**: Install the latest stable `Docker Compose <https://docs.docker.com/compose/install/>`_
and add it to the PATH. ``Breeze`` detects if you are using version that is too old and warns you to upgrade.
- **Permissions**: Configure permission to be able to run the ``docker-compose`` command by your user.

Expand Down
17 changes: 3 additions & 14 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,27 +215,16 @@ also have support for popular remote development environments: GitHub Codespaces
You can see the differences between the various environments
`here <https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#development-environments>`__.

The local env instructions can be found in full in the `LOCAL_VIRTUALENV.rst`_ file.

.. _LOCAL_VIRTUALENV.rst:
https://github.com/apache/airflow/blob/main/LOCAL_VIRTUALENV.rst
The local env instructions can be found in full in the `LOCAL_VIRTUALENV.rst <https://github.com/apache/airflow/blob/main/LOCAL_VIRTUALENV.rst>`_ file.

The Breeze Docker Compose env is to maintain a consistent and common development environment so that you
can replicate CI failures locally and work on solving them locally rather by pushing to CI.

The Breeze instructions can be found in full in the `BREEZE.rst`_ file.

.. _BREEZE.rst:
https://github.com/apache/airflow/blob/main/BREEZE.rst
The Breeze instructions can be found in full in the `BREEZE.rst <https://github.com/apache/airflow/blob/main/BREEZE.rst>`_ file.

You can configure the Docker-based Breeze development environment as follows:

1. Install the latest versions of the `Docker Community Edition`_ and `Docker Compose`_ and add them to the PATH.

.. _Docker Community Edition:
https://github.com/apache/airflow/blob/main/BREEZE.rst#docker-community-edition

.. _Docker Compose: https://github.com/apache/airflow/blob/main/BREEZE.rst#docker-compose
1. Install the latest versions of the `Docker Community Edition <https://docs.docker.com/get-docker/>`_ and `Docker Compose <https://docs.docker.com/compose/install/#install-compose>`_ and add them to the PATH.

2. Install `jq`_ on your machine. The exact command depends on the operating system (or Linux distribution) you use.

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTORS_QUICK_START.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ Forking and cloning Project
alt="Cloning github fork of Apache airflow">
</div>

3. Follow `Cloning a repository<https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository>`_
3. Follow `Cloning a repository <https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository>`_
to clone the repo locally (you can also do it in your IDE - see the `Using your IDE <using-your-ide>`_
chapter below.

Expand Down

0 comments on commit 33eef7b

Please sign in to comment.