From 33eef7b8a1f6c7838c0833ab95361ffc826262bf Mon Sep 17 00:00:00 2001
From: Edith Puclla <58795858+edithturn@users.noreply.github.com>
Date: Sat, 28 May 2022 02:10:19 -0500
Subject: [PATCH] Fix links in documentation (#23975)
* fix links
* added right link to breeze
---
BREEZE.rst | 2 +-
CONTRIBUTING.rst | 17 +++--------------
CONTRIBUTORS_QUICK_START.rst | 2 +-
3 files changed, 5 insertions(+), 16 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 2facbd3662b55..8f5a6e105379c 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -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`_
+- **Version**: Install the latest stable `Docker Compose `_
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.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 39d807f55d1ce..99527bbcedd75 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -215,27 +215,16 @@ also have support for popular remote development environments: GitHub Codespaces
You can see the differences between the various environments
`here `__.
-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 `_ 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 `_ 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 `_ and `Docker 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.
diff --git a/CONTRIBUTORS_QUICK_START.rst b/CONTRIBUTORS_QUICK_START.rst
index 2f9af5bbc7796..10ff2cc9516d9 100644
--- a/CONTRIBUTORS_QUICK_START.rst
+++ b/CONTRIBUTORS_QUICK_START.rst
@@ -190,7 +190,7 @@ Forking and cloning Project
alt="Cloning github fork of Apache airflow">
-3. Follow `Cloning a repository`_
+3. Follow `Cloning a repository `_
to clone the repo locally (you can also do it in your IDE - see the `Using your IDE `_
chapter below.