VBhojawala commented on a change in pull request #12346: URL: https://github.com/apache/airflow/pull/12346#discussion_r523375658
########## File path: docs/contributrs-quick-start.rst ########## @@ -0,0 +1,915 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +************************* +Contributor's Quick Guide +************************* + +.. contents:: :local: + + +Prerequisites +############# + +1. Docker Community Edition +2. Docker Compose +3. pyenv (you can also use pyenv-virtualenv or virtualenvwrapper) + + +Installing Prerequisites on Ubuntu +################################### + + +Docker Community Edition +----------------------------------- + + +1. Installing required packages for Docker and setting up docker repo + +.. code-block:: bash + + $ sudo apt-get update + + $ sudo apt-get install \ + apt-transport-https \ + ca-certificates \ + curl \ + gnupg-agent \ + software-properties-common + + $ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add - + + $ sudo add-apt-repository \ + "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ + $(lsb_release -cs) \ + stable" + +2. Install Docker + +.. code-block:: bash + + $ sudo apt-get update + $ sudo apt-get install docker-ce docker-ce-cli containerd.io + +3. Creating group for docker and adding current user to it. + +.. code-block:: bash + + $ sudo groupadd docker + $ sudo usermod -aG docker $USER + +Note : After adding user to docker group Logout and Login again for group membership re-evaluation. + +4. Test Docker installation + +.. code-block:: bash + + $ docker run hello-world + + + + +Docker Compose +-------------------------- + +1. Check the latest version of Docker Compose version |here| and Install + +.. |here| raw:: html + + <a href="https://docs.docker.com/compose/install/#install-compose- + on-linux-systems">here</a> + +.. code-block:: bash + + $ sudo curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compose-$(uname -s)-$(uname -m)" \ Review comment: Nice, i will add this in next commit. ---------------------------------------------------------------- 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: us...@infra.apache.org
