From c48b0ef565c4ddaab6caf31c78b90d2c96480c50 Mon Sep 17 00:00:00 2001 From: Roman Gorshunov Date: Mon, 24 Sep 2018 12:53:27 +0200 Subject: [PATCH] Fix: various documentation and URL fixes 1) UCP -> Airship 2) readthedocs.org -> readthedocs.io (there is redirect) 3) http -> https 4) attcomdev -> airshipit (repo on quay.io) 5) att-comdev -> openstack/airship-* (repo on github/openstack git) 6) many URLs have been verified and adjusted to be current 7) no need for 'en/latest/' path in URL of the RTD 8) added more info to some setup.cfg and setup.py files 9) ucp-integration docs are now in airship-in-a-bottle 10) various other minor fixes Change-Id: I3a325f004d47d69f2d382f071e342c4e4c50ab0b --- README.rst | 4 ++-- doc/source/cli.rst | 2 +- doc/source/developer-overview.rst | 6 +++--- setup.py | 6 ++++++ 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index b02e0f82..fabddb27 100644 --- a/README.rst +++ b/README.rst @@ -48,8 +48,8 @@ Further Reading `Airship`_. -.. |Doc Status| image:: https://readthedocs.org/projects/airship-pegleg/badge/?version=latest - :target: http://airship-pegleg.readthedocs.io/ +.. |Doc Status| image:: https://readthedocs.io/projects/airship-pegleg/badge/?version=latest + :target: https://airship-pegleg.readthedocs.io/ .. _Deckhand: https://airship-deckhand.readthedocs.io .. _Airship: https://www.airshipit.org .. _Read the Docs: https://airship-pegleg.readthedocs.io diff --git a/doc/source/cli.rst b/doc/source/cli.rst index e50e59e8..0b8d8516 100644 --- a/doc/source/cli.rst +++ b/doc/source/cli.rst @@ -41,7 +41,7 @@ Environment Variables $IMAGE = Location of pegleg docker image. - Example: $IMAGE=quay.io/attcomdev/pegleg:latest + Example: $IMAGE=quay.io/airshipit/pegleg:latest Usage ===== diff --git a/doc/source/developer-overview.rst b/doc/source/developer-overview.rst index 2f85c80b..1961fc2b 100644 --- a/doc/source/developer-overview.rst +++ b/doc/source/developer-overview.rst @@ -97,8 +97,8 @@ Pegleg comes equipped with a number of `tox`_ targets for running unit tests, as well as `pep8`_ and `Bandit`_ checks. .. _Airship: https://airshipit.readthedocs.io -.. _Deckhand: https://airship-deckhand.readthedocs.io/en/latest/ -.. _Airship coding conventions: http://airshipit.readthedocs.io/en/latest/conventions.html -.. _tox: https://tox.readthedocs.io/en/latest/ +.. _Deckhand: https://airship-deckhand.readthedocs.io/ +.. _Airship coding conventions: https://airshipit.readthedocs.io/en/latest/conventions.html +.. _tox: https://tox.readthedocs.io/ .. _pep8: https://www.python.org/dev/peps/pep-0008/ .. _Bandit: https://github.com/PyCQA/bandit diff --git a/setup.py b/setup.py index 551be083..5406475b 100644 --- a/setup.py +++ b/setup.py @@ -19,6 +19,12 @@ setup( name='pegleg', python_requires='>=3.5.0', version='0.1.0', + description=('Pegleg is a document aggregator that provides early ' + 'linting and validations via Deckhand, a document ' + 'management micro-service within Airship.'), + url='https://github.com/openstack/airship-pegleg', + author='The Airship Authors', + license='Apache 2.0', packages=find_packages(), entry_points={ 'console_scripts': [