Fixing docs(#497)

Author: JohnPreston

CONTRIBUTING.rst

@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/lanbda-my-aws/ecs_composex/issues.
+The best way to send feedback is to file an issue at https://github.com/compose-x/ecs_composex/issues.
 
 If you are proposing a feature:
 
@@ -64,11 +64,13 @@ Ready to contribute? Here's how to set up `ecs_composex` for local development.
 
     $ git clone git@github.com:your_name_here/ecs_composex.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy into a virtualenv. Assuming you have python3 and pip installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv ecs_composex
+    $ python -m venv venv
+    $ source venv/bin/activate
     $ cd ecs_composex/
-    $ python setup.py develop
+    $ pip install poetry
+    $ poetry install
 
 4. Create a branch for local development::
 
@@ -80,6 +82,7 @@ Ready to contribute? Here's how to set up `ecs_composex` for local development.
    tests, including testing other Python versions with tox::
 
     $ make lint
+    $ make conform
     $ make coverage
 
    To get flake8 and tox, just pip install them into your virtualenv.
@@ -108,6 +111,7 @@ Tips
 To run a subset of tests::
 
 $ make test
+$ make conform
 $ make coverage
 
 
@@ -118,7 +122,7 @@ A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed (including an entry in HISTORY.rst).
 Then run::
 
-$ bump2version patch # possible: major / minor / patch
+$ tbump --no-push major.minor.patch
 $ git push
 $ git push --tags
 

docs/examples.rst

@@ -0,0 +1,10 @@
+.. meta::
+    :description: ECS Compose-X Labs
+    :keywords: AWS, AWS ECS, Docker, Containers, Compose, docker-compose, install, setup, examples
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Examples
+
+    examples/lab
+    examples/nginx_simple

docs/examples/lab.rst

@@ -0,0 +1,22 @@
+.. meta::
+    :description: ECS Compose-X Labs
+    :keywords: AWS, AWS ECS, Docker, Containers, Compose, docker-compose, install, setup, examples
+
+=================
+Compose-X Labs
+=================
+
+There are tons of use-cases out there to use docker-compose, and a lot of various applications that can be deployed
+to AWS very easily
+
+Whilst the examples on this site will aim to help users gradually add in complexity, more in details and in-depth examples
+which relate to real-life use-cases that helped shape and test compose-x can be found at `Compose-X Labs`_
+
+.. seealso::
+
+    * `Compose-X Labs`_
+
+    * `Compose-X Labs GitHub repository`_ (contains the source and artifacts of the lab articles)
+
+.. _Compose-X Labs: https://labs.compose-x.io
+.. _Compose-X Labs GitHub repository: https://github.com/compose-x/compose-x-labs

docs/examples/nginx_simple.rst

@@ -0,0 +1,5 @@
+.. meta::
+    :description: ECS Compose-X Labs
+    :keywords: AWS, AWS ECS, Docker, Containers, Compose, docker-compose, install, setup, examples
+
+.. include:: ../../e2e-examples/nginx_webapp/README.rst

docs/index.rst

@@ -6,13 +6,11 @@
 Welcome to ECS Compose-X documentation
 ========================================
 
-|PYPI_VERSION| |PYPI_LICENSE|
+|PYPI_VERSION| |PYPI_LICENSE| |PY_DLS|
 
 |CODE_STYLE| |TDD| |BDD|
 
-|QUALITY|
-
-|BUILD|
+|QUALITY| |BUILD|
 
 ---------------------------------------------------------------------------------------------------------------
 Manage, Configure and deploy your applications/services and AWS resources from your docker-compose definitions
@@ -52,14 +50,20 @@ Deploy it in your account today |AWS_SAR|
 
 `Find out how to use ECS Compose-X in AWS here`_
 
+Via docker
+-----------
+
+.. code-block:: bash
+
+    docker run --rm -v ~/.aws:/root/.aws public.ecr.aws/compose-x/compose-x:latest
+
 Via pip
 --------
 
 .. code-block:: bash
 
     pip install ecs_composex
 
-
 CLI Usage
 ==========
 
@@ -153,7 +157,7 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
 .. _Troposphere: https://github.com/cloudtools/troposphere
 .. _Blog: https://blog.compose-x.io/
 .. _Docker Compose: https://docs.docker.com/compose/
-.. _ECS Compose-X: https://github.com/lambda-my-aws/ecs_composex
+.. _ECS Compose-X: https://github.com/compose-x/ecs_composex
 .. _YAML Specifications: https://yaml.org/spec/
 .. _Extensions fields:  https://docs.docker.com/compose/compose-file/#extension-fields
 .. _ECS Compose-X Project: https://github.com/orgs/lambda-my-aws/projects/3
@@ -203,6 +207,9 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
     :alt: Code scan with SonarCloud
     :target: https://sonarcloud.io/dashboard?id=compose-x_ecs_composex
 
+.. |PY_DLS| image:: https://img.shields.io/pypi/dm/ecs-composex
+    :target: https://pypi.org/project/ecs-composex/
+
 
 .. toctree::
     :maxdepth: 1
@@ -213,6 +220,7 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
     macro_usage
     contributing
 
+.. include:: examples.rst
 .. include:: compatibility_matrix.rst
 .. include:: modules_syntax.rst
 

docs/installation.rst

@@ -12,14 +12,34 @@ Installation
 Stable release
 ==============
 
+From docker
+------------
+
+.. code-block:: console
+
+    docker run --rm -v ~/.aws:/root/.aws public.ecr.aws/compose-x/compose-x:latest
+
+.. hint::
+
+    Head to https://gallery.ecr.aws/compose-x/compose-x to select a particular version if need be.
+
 From Pip
 ---------
 
 To install ECS-Compose-X, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install ecs_composex
+    pip install --user ecs_composex
+
+.. hint::
+
+    Highly recommend to create a new python virtualenv in order not to spread on all your machine
+
+    .. code-block:: console
+
+        python -m venv venv
+        source venv/bin/activate
 
 This is the preferred method to install ECS-Compose-X, as it will always install the most recent stable release.
 
@@ -36,22 +56,41 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/lambda-my-aws/ecs_composex
+    $ git clone git://github.com/compose-x/ecs_composex
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/lambda-my-aws/ecs_composex/tarball/master
+    $ curl -OJL https://github.com/compose-x/ecs_composex/tarball/main
+
+Once you have a copy of the source, you can install it
+
+
+Using pip
+-----------
+
+.. code-block:: console
+
+    # After git clone
+    cd ecs_composex
+    pip install .
 
-Once you have a copy of the source, you can install it with:
+Using poetry
+-------------------
 
 .. code-block:: console
 
-    $ python setup.py install
+    # After git clone
+    cd ecs_composex
+    python -m pip install poetry
+    poetry install
+
+.. hint::
 
+    Using poetry will also install all the dev dependencies for local dev.
 
-.. _Github repo: https://github.com/lambda-my-aws/ecs_composex
-.. _tarball: https://github.com/lambda-my-aws/ecs_composex/tarball/master
+.. _Github repo: https://github.com/compose-x/ecs_composex
+.. _tarball: https://github.com/compose-x/ecs_composex/tarball/master
 .. _pip: https://pip.pypa.io
 .. _Python installation guide: http://docs.python-guide.org/en/latest/starting/installation/

docs/story.rst

@@ -30,7 +30,7 @@ Community focused
 Any new Feature Request submitted by someone other than myself will get their request prioritized to try address their
 use-cases as quickly as possible.
 
-`Submit your Feature Request here <https://github.com/lambda-my-aws/ecs_composex/issues/new/choose>`_
+`Submit your Feature Request here <https://github.com/compose-x/ecs_composex/issues/new/choose>`_
 
 Ensure things work
 ------------------
@@ -39,7 +39,7 @@ It takes an insane amount of time to test everything as, generating CFN template
 works end-to-end is a completely different thing.
 
 I will always do my best to ensure that any new feature is tested end-to-end, but shall anything slip through the cracks,
-please feel free to report your errors `here <https://github.com/lambda-my-aws/ecs_composex/issues/new/choose>`_
+please feel free to report your errors `here <https://github.com/compose-x/ecs_composex/issues/new/choose>`_
 
 
 Provision other AWS resources your services need
@@ -168,6 +168,6 @@ can solve that problem and with ECS Compose-X the effort is to constantly abide
 .. _Troposphere: https://github.com/cloudtools/troposphere
 .. _Blog: https://blog.composex.io/
 .. _Docker Compose: https://docs.docker.com/compose/
-.. _ECS Compose-X: https://github.com/lambda-my-aws/ecs_composex
+.. _ECS Compose-X: https://github.com/compose-x/ecs_composex
 .. _YAML Specifications: https://yaml.org/spec/
 .. _Extensions fields:  https://docs.docker.com/compose/compose-file/#extension-fields

docs/syntax/compose_x/codeguru_profiler.rst

@@ -89,4 +89,4 @@ Example
 Code Example
 -------------
 
-Full Applications code used for this sort of testing can be found `here <https://github.com/lambda-my-aws/composex-testing-apps/tree/main/app02>`__
+Full Applications code used for this sort of testing can be found `here <https://github.com/compose-x/composex-testing-apps/tree/main/app02>`__

e2e-examples/nginx_webapp/Dockerfile

@@ -0,0 +1,4 @@
+ARG BASE_IMAGE=nginx:latest
+
+FROM $BASE_IMAGE
+COPY app/* /usr/share/nginx/html