From 5b8a896333d7e9df357da2fd70d92526dc611606 Mon Sep 17 00:00:00 2001 From: Kent Pitman Date: Wed, 6 Sep 2023 09:49:37 -0400 Subject: [PATCH 1/3] Update README in various ways. --- CHANGELOG.rst | 8 +++++- README.rst | 68 +++++++++++++++++++++++++++++++++++++------------- pyproject.toml | 2 +- 3 files changed, 59 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a139de0e7c..0c76ea4b25 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -6,6 +6,12 @@ cgap-portal Change Log ---------- +14.2.3 +====== + +* Update README.rst + + 14.2.2 ====== `PR 741: Style updates for cgap-portal item-pages `_ @@ -1186,4 +1192,4 @@ the ``poetry.app`` section of ``pyproject.toml`` for the corresponding change, a version = "100.200.300" ...etc. -This would correspond with ``cgap-portal 100.200.300``. \ No newline at end of file +This would correspond with ``cgap-portal 100.200.300``. diff --git a/README.rst b/README.rst index 4a9206930c..1633f10dde 100644 --- a/README.rst +++ b/README.rst @@ -3,38 +3,56 @@ ======================== .. image:: https://github.com/dbmi-bgm/cgap-portal/actions/workflows/main.yml/badge.svg + :target: https://github.com/dbmi-bgm/cgap-portal/actions + :alt: Build Status + +.. image:: https://coveralls.io/repos/github/dbmi-bgm/cgap-portal/badge.svg + :target: https://coveralls.io/github/dbmi-bgm/cgap-portal + :alt: Coverage Percentage .. image:: https://readthedocs.org/projects/cgap-portal/badge/?version=latest + :target: https://cgap-portal.readthedocs.io/en/latest/ + :alt: Documentation Status .. image:: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiVjRJaE5DeHE3a0tjcGcwb01FaDZvSU5Id056amkwazV0UWlJM29IaEM2VWVlMm5INjhKS1dMVTRCMVAwSVl0RmFJR05zOHVHZUFrWStKdzBaV0VKZm04PSIsIml2UGFyYW1ldGVyU3BlYyI6Im1mMVFVOW10dFltQ2dLQkIiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master + :alt: CodeBuild Status + + +Welcome to CGAP! +================ +We are a team of scientists, clinicians, and developers +who aim to streamline the clinical genetics workflow. -Welcome to CGAP! We are a team of scientists, clinicians, and developers who aim to streamline the clinical genetics workflow. The following locations are different deployments of our data portal: +* For useful information about CGAP's features, + see `the CGAP informational site `_. -* `Production `_ for the stable release -* `cgapdev `_ for data model and back-end development -* `cgaptest `_ for front-end and UX development -* `cgapwolf `_ for workflow development +* CGAP is orchestrated technology capable of being easily deployed + in hospital setting. Our flagship site is + `CGAP-MGB `_. -Be warned that features are under active development and may not be stable! Visit the production deployment for the best experience. For installation and more information on getting started, see our `documentation page `_. + For information on how to set your hospital up to use this technology, + `contact us `_. -Note that at this time, CGAP is operating in hybrid model where some environments are deployed to AWS ElasticBeanstalk and others are deployed to AWS Elastic Container Service. The BS deployments are referred to as "legacy deployments" and the ECS deployments are referred to as "alpha deployments". +* CGAP is an open source system under continuous development. + For documentation, see + `the CGAP Portal page at ReadTheDocs + `_. -For information on how to run CGAP with Docker, see `here. <./docs/source/docker-local.rst>`_ +* For information about governance and other policies, see + `the CGAP Governance repository + `_. -For information on CGAP-Docker in production, see `here. <./docs/source/docker-production.rst>`_ -Navigating this Repository -^^^^^^^^^^^^^^^^^^^^^^^^^^ +Repository Structure +-------------------- -Important directories/files are outlined below. +These are some important files and directories you might want to be aware of: * ``.github/workflows/`` contains Github Action Workflows - * ``.ebextensions/`` contains the Elastic Beanstalk provisioning scripts - * ``bin/`` contains the few remaining executables + * ``bin/`` contains a few legacy scripts, though most are in ``scripts/`` * ``deploy/docker`` contains containerization related scripts/configuration * ``docs/ contains`` documentation - * ``parts/`` contains WSGI entry points for the Beanstalk setup * ``scripts/`` contains misc scripts * ``src/encoded/`` where the code is * ``.dockerignore`` specifies paths ignored by the Dockerfile @@ -45,8 +63,9 @@ Important directories/files are outlined below. * ``pyproject.toml`` and ``poetry.lock`` specify the back-end dependencies * ``setup_eb.py`` performs final installation setup -Navigating src/encoded/ -^^^^^^^^^^^^^^^^^^^^^^^ + +Navigating core functionality (src/encoded/) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Top level files are modules that make up the core functionality of the back-end. Some modules differ greatly from or do not even exist in fourfront. Directories are outlined below. @@ -61,3 +80,18 @@ not even exist in fourfront. Directories are outlined below. * ``tests/`` contains back-end unit tests and insert data * ``types/`` contains metadata type definitions * ``upgrade/`` contains collection schema version upgraders - are not functioning as intended currently + + +Related Repositories +~~~~~~~~~~~~~~~~~~~~ + +Note that ``cgap-portal`` is bound on supporting functionality +in numerous libaries, but importantly: + + * **dcicsnovault** + [`pypi library `_] + [`source repo `_] + + * **dcicutils** + [`pypi library `_] + [`source repo `_] diff --git a/pyproject.toml b/pyproject.toml index 2c4b5fa3ad..559ceab769 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] # Note: Various modules refer to this system as "encoded", not "cgap-portal". name = "encoded" -version = "14.2.2" +version = "14.2.3" description = "Computational Genome Analysis Platform" authors = ["4DN-DCIC Team "] license = "MIT" From 78bc0eb67c3d4c12f146cc88c1816df8aec9a7f0 Mon Sep 17 00:00:00 2001 From: William Ronchetti Date: Wed, 6 Sep 2023 10:53:54 -0400 Subject: [PATCH 2/3] small changes --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 1633f10dde..63c5f2f5e6 100644 --- a/README.rst +++ b/README.rst @@ -14,7 +14,7 @@ :target: https://cgap-portal.readthedocs.io/en/latest/ :alt: Documentation Status -.. image:: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiVjRJaE5DeHE3a0tjcGcwb01FaDZvSU5Id056amkwazV0UWlJM29IaEM2VWVlMm5INjhKS1dMVTRCMVAwSVl0RmFJR05zOHVHZUFrWStKdzBaV0VKZm04PSIsIml2UGFyYW1ldGVyU3BlYyI6Im1mMVFVOW10dFltQ2dLQkIiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master +.. image:: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMWtFYjJTeXkzcXZVYkpmbkd3VUlOQ0pSTnlLRGloVENJcitGS1g1RTV1THgxQkc3M2tDY0NFUFUxOXRBeS92dUNtbXdRZU5YWEkzbUhaMm1lUlNDZ2NZPSIsIml2UGFyYW1ldGVyU3BlYyI6Ijl6OUZkY3JvaWlyZDduUnEiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master :alt: CodeBuild Status @@ -79,7 +79,7 @@ not even exist in fourfront. Directories are outlined below. * ``static/`` contains front-end code * ``tests/`` contains back-end unit tests and insert data * ``types/`` contains metadata type definitions - * ``upgrade/`` contains collection schema version upgraders - are not functioning as intended currently + * ``upgrade/`` contains collection schema version upgraders Related Repositories From abef30a3d11b96abdf1d920a33c77faf69ff4c64 Mon Sep 17 00:00:00 2001 From: Kent Pitman Date: Wed, 6 Sep 2023 13:05:41 -0400 Subject: [PATCH 3/3] Mostly more cosmetics, but remove codebuild status which isn't working (probably because the build is not public). --- README.rst | 65 +++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 33 deletions(-) diff --git a/README.rst b/README.rst index 63c5f2f5e6..0295b5a0d0 100644 --- a/README.rst +++ b/README.rst @@ -14,13 +14,12 @@ :target: https://cgap-portal.readthedocs.io/en/latest/ :alt: Documentation Status -.. image:: https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiMWtFYjJTeXkzcXZVYkpmbkd3VUlOQ0pSTnlLRGloVENJcitGS1g1RTV1THgxQkc3M2tDY0NFUFUxOXRBeS92dUNtbXdRZU5YWEkzbUhaMm1lUlNDZ2NZPSIsIml2UGFyYW1ldGVyU3BlYyI6Ijl6OUZkY3JvaWlyZDduUnEiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master - :alt: CodeBuild Status - Welcome to CGAP! ================ +CGAP is the Computational Genome Analysis Platform. + We are a team of scientists, clinicians, and developers who aim to streamline the clinical genetics workflow. @@ -37,7 +36,7 @@ who aim to streamline the clinical genetics workflow. * CGAP is an open source system under continuous development. For documentation, see `the CGAP Portal page at ReadTheDocs - `_. + `_. * For information about governance and other policies, see `the CGAP Governance repository @@ -49,19 +48,19 @@ Repository Structure These are some important files and directories you might want to be aware of: - * ``.github/workflows/`` contains Github Action Workflows - * ``bin/`` contains a few legacy scripts, though most are in ``scripts/`` - * ``deploy/docker`` contains containerization related scripts/configuration - * ``docs/ contains`` documentation - * ``scripts/`` contains misc scripts - * ``src/encoded/`` where the code is - * ``.dockerignore`` specifies paths ignored by the Dockerfile - * ``Dockerfile`` contains the Docker build instructions for the cgap-portal - see ``docker-production.rst`` - * ``Makefile`` contains macros for common build operations - see ``make info`` - * ``docker-compose.yml`` builds the new local deployment - see ``docker-local.rst`` - * ``package.json`` and ``package-lock.json`` specify the front-end dependencies - * ``pyproject.toml`` and ``poetry.lock`` specify the back-end dependencies - * ``setup_eb.py`` performs final installation setup +* ``.dockerignore`` specifies paths ignored by the Dockerfile +* ``.github/workflows/`` contains Github Action Workflows +* ``bin/`` contains a few legacy scripts, though most are in ``scripts/`` +* ``deploy/docker`` contains containerization related scripts/configuration +* ``docker-compose.yml`` builds the new local deployment (see ``docker-local.rst``) +* ``Dockerfile`` contains the Docker build instructions for the cgap-portal (see ``docker-production.rst``) +* ``docs/ contains`` documentation +* ``Makefile`` contains macros for common build operations (see ``make info``) +* ``package.json`` and ``package-lock.json`` specify the front-end dependencies +* ``pyproject.toml`` and ``poetry.lock`` specify the back-end dependencies +* ``scripts/`` contains misc scripts +* ``setup_eb.py`` performs final installation setup +* ``src/encoded/`` where the code is Navigating core functionality (src/encoded/) @@ -70,16 +69,16 @@ Navigating core functionality (src/encoded/) Top level files are modules that make up the core functionality of the back-end. Some modules differ greatly from or do not even exist in fourfront. Directories are outlined below. - * ``annotations/`` contains mapping table and ingestion related metadata - * ``commands/`` contains Python commands that can be run on the system from the command line - * ``docs/`` contains ReadTheDocs documentation - * ``ingestion/`` contains ingestion related code, such as mapping table intake and VCF processing - * ``schemas/`` contains the metadata schemas - * ``search/`` contains the search/filter_set APIs - * ``static/`` contains front-end code - * ``tests/`` contains back-end unit tests and insert data - * ``types/`` contains metadata type definitions - * ``upgrade/`` contains collection schema version upgraders +* ``annotations/`` contains mapping table and ingestion related metadata +* ``commands/`` contains Python commands that can be run on the system from the command line +* ``docs/`` contains ReadTheDocs documentation +* ``ingestion/`` contains ingestion related code, such as mapping table intake and VCF processing +* ``schemas/`` contains the metadata schemas +* ``search/`` contains the search/filter_set APIs +* ``static/`` contains front-end code +* ``tests/`` contains back-end unit tests and insert data +* ``types/`` contains metadata type definitions +* ``upgrade/`` contains collection schema version upgraders Related Repositories @@ -88,10 +87,10 @@ Related Repositories Note that ``cgap-portal`` is bound on supporting functionality in numerous libaries, but importantly: - * **dcicsnovault** - [`pypi library `_] - [`source repo `_] +* **dcicsnovault** + [`pypi library `_] + [`source repo `_] - * **dcicutils** - [`pypi library `_] - [`source repo `_] +* **dcicutils** + [`pypi library `_] + [`source repo `_]