Merge branch '63-update-docs-to-new-location' into 'dev'

Resolve "update docs to new location"

See merge request id2/software/services/fair/software-quality-assurance!61

.gitlab/ci/lint.gitlab-ci.yml

@@ -5,7 +5,7 @@
 
 lint:Python:
   stage: lint
-  image: gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
+  image: git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
   before_script:
     - pip install pylint
   script:

.gitlab/ci/sqa.gitlab-ci.yml

@@ -19,7 +19,7 @@ sqa:dev:
     - eval $(ssh-agent -s)
     - echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
     - git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
-    - git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
+    - git config user.email "software-quality-assurance@git.gfz-potsdam.de"
     - sqa --repository_dir "$CI_PROJECT_DIR" run
     - git add .
     - git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"
@@ -44,7 +44,7 @@ sqa:production:
     - eval $(ssh-agent -s)
     - echo "$GITLAB_DEPLOY_KEY" | tr -d '\r' | ssh-add -
     - git config user.name "GitLab CI:${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}"
-    - git config user.email "software-quality-assurance@gitext.gfz-potsdam.de"
+    - git config user.email "software-quality-assurance@git.gfz-potsdam.de"
     - sqa --repository_dir "$CI_PROJECT_DIR" run
     - git add .
     - git commit -m "[AUTOMATIC] generated meta/software-quality-assurance-report.md by gitlab ci"

.gitlab/ci/test.gitlab-ci.yml

@@ -87,3 +87,16 @@ test:docs:
     changes:
       - "docs/**/*"
       - "**/*.md"
+
+test:check-links:
+  stage: test
+  image: ruby:2.7.2-slim-buster
+  before_script:
+    - gem install awesome_bot
+  script:
+    - awesome_bot --allow-redirect --allow-dupe `find . -type d \( -path .sqa -o -path tests/test_project \) -prune -false -o -name "*.md"`
+  only:
+    changes:
+      - "**/*.md"
+      - ".gitlab-ci.yml"
+      - ".gitlab/ci/test.gitlab-ci.yml"

CONTRIBUTING.md

@@ -17,7 +17,7 @@ You can contribute in many ways:
 ### Report Bugs
 
 
-Report bugs as [issue](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues).
+Report bugs as [issue](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/issues).
 
 If you are reporting a bug, please include:
 
@@ -44,7 +44,7 @@ Whether as part of the official docs or in the docstrings.
 
 ### Submit Feedback
 
-The best way to send feedback is to file an issue at https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/issues.
+The best way to send feedback is to file an issue at https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/issues.
 
 If you are proposing a feature:
 
@@ -59,11 +59,11 @@ Ready to contribute? Here's how to set up `Software Quality Assurance` for local
 1. Fork the `Software Quality Assurance` repo on GitLab.
 2. Clone your fork locally:
     ```shell
-    $ git clone git@gitext.gfz-potsdam.de:your_name_here/software-quality-assurance.git
+    $ git clone git@git.gfz-potsdam.de:your_name_here/software-quality-assurance.git
     ```
-3. Create a branch for local development:
+3. Create a branch for local development from the dev branch:
     ```shell
-    $ git checkout -b name-of-your-bugfix-or-feature
+    $ git checkout -b name-of-your-bugfix-or-feature dev
     ```
     Now you can make your changes locally.
 4. Commit your changes and push your branch to GitLab:
@@ -92,5 +92,5 @@ Before you submit a pull request, check that it meets these guidelines:
 
 1. The merge request should include tests.
 2. If the merge request adds functionality, the docs should be updated.
-3. Check your [merge request](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/merge_requests) and make sure that the tests pass.
+3. Check your [merge request](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/merge_requests) and make sure that the tests pass.
 4. All changes need to be compatible with the respective [license](README.md#license).

QUALITY.md

 # Software Quality Report
-> **Note:** This report is automatically generated by [Software Quality Assurance](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)
+> **Note:** This report is automatically generated by [Software Quality Assurance](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)
 
 ## Table of Content
 
@@ -18,9 +18,9 @@
 
 **Software Location:** [git](git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)
 
-**Last Commit:** 02c7ad31fc69487750063b02e502a1d7cfa7476b
+**Last Commit:** fd7d82dcc8478db17bed2c43b8480e003a624f3b
 
-**Report Time:** 30/03/2021 06:51:45 UTC
+**Report Time:** 30/03/2021 06:56:53 UTC
 
 **Report Version:** 0.6.0
 
@@ -47,10 +47,10 @@ Usage:  gitleaks [OPTIONS]Application Options:  -v, --verbose             Show v
 
 > **Description: Lists all people that committed to this config.**
 
-* [GitLab CI:hifis/software-services/fair/ci-services](mailto:ci-services@gitext.gfz-potsdam.de)
-* [GitLab CI:id2/software/services/fair/software-quality-assurance](mailto:software-quality-assurance@gitext.gfz-potsdam.de)
-* [GitLab CI:software/services/fair/ci-services](mailto:ci-services@gitext.gfz-potsdam.de)
-* [GitLab CI:software/services/fair/software-quality-assurance](mailto:software-quality-assurance@gitext.gfz-potsdam.de)
+* [GitLab CI:hifis/software-services/fair/ci-services](mailto:ci-services@git.gfz-potsdam.de)
+* [GitLab CI:id2/software/services/fair/software-quality-assurance](mailto:software-quality-assurance@git.gfz-potsdam.de)
+* [GitLab CI:software/services/fair/ci-services](mailto:ci-services@git.gfz-potsdam.de)
+* [GitLab CI:software/services/fair/software-quality-assurance](mailto:software-quality-assurance@git.gfz-potsdam.de)
 * [Hannes Fuchs](mailto:hannes.fuchs@gfz-potsdam.de)
 * [Maximilian Dolling](mailto:mdolling@gfz-potsdam.de)
 * [mdolling](mailto:mdolling@gfz-potsdam.de)

README.md

@@ -37,7 +37,7 @@ The software you want to run the services on **must** be a [git](https://git-scm
 
 ## Documentation
 
-You can find the documentation [here](https://id2.git-pages.gfz-potsdam.de/software/services/fair/software-quality-assurance/).
+You can find the documentation [here](https://id2.git-pages.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/).
 In case you received a local copy of the project, you can build and view the documentation like this:
 ```shell script
 cd docs

build/docker/app/Dockerfile_dev

@@ -22,7 +22,7 @@
 # You can find a copy of the license in the LICENSES folder.
 # If not, see <http://www.gnu.org/licenses/>.
 
-FROM gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
+FROM git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep-dev
 
 LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
 

build/docker/app/Dockerfile_prod

@@ -22,7 +22,7 @@
 # You can find a copy of the license in the LICENSES folder.
 # If not, see <http://www.gnu.org/licenses/>.
 
-FROM gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep
+FROM git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest-dep
 
 LABEL maintainer="Maximilian Dolling <mdolling@gfz-potsdam.de>"
 

docs/index.rst

@@ -37,8 +37,8 @@ Structure of the Documentation
     pages/AUTHORS.md
     pages/CONTRIBUTING.md
     pages/CHANGELOG.md
-    SQA report <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/QUALITY.md>
-    Source Code <https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance>
+    SQA report <https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/blob/master/QUALITY.md>
+    Source Code <https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance>
 
 .. _RSEs: https://de-rse.org/en/
 .. _git: https://git-scm.com/

docs/pages/installation.md

@@ -54,7 +54,7 @@ The same reason prevents it currently from being hosted on PyPI.
 Please make sure, all requirements are met.
 
 ```shell script
-git clone https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance.git
+git clone https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance.git
 cd software-quality-assurance/src
 python setup.py install
 ```

docs/pages/usage.md

@@ -82,7 +82,7 @@ stages:
 sqa:
   stage: sqa
   image:
-    name: "gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
+    name: "git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
     entrypoint: [""]
   script:
     - sqa --repository_dir "$CI_PROJECT_DIR" run
@@ -131,9 +131,9 @@ ssh-keyscan -t rsa [GITLAB_DOMAIN]]
 
 # example
 
-ssh-keyscan -t rsa gitext.gfz-potsdam.de
-# gitext.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
-gitext.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF
+ssh-keyscan -t rsa git.gfz-potsdam.de
+# git.gfz-potsdam.de:22 SSH-2.0-OpenSSH_7.6p1 Ubuntu-4ubuntu0.3
+git.gfz-potsdam.de ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCsiq5txhABcG9oePf47SCd+w/tfSs6NWKaMRd2BfBi9DGORQX4wwV4CYvSJbMfJvQO5SMGwhnEAXe0bWihC2V8X7lzcePrpjfP+uH2lmipcFbV9g3iQpM7Fusr96IV65v/qQ6HE4+KkHJLR1vEKj1AOaVgDww7CHhVAHCkvqcSwwtfOjBbqyfQ2Su7O6UNzs1ecQcIXnQNO8ebzimv3c8mKdo9j8i5eiWVqzRivmi/R3XIIc2T695mTLyxUplqfyvZpDL90F9VEjr/3HM9/3dASbonaTH8SoMRCxOy8Fpz0Va1MdpSor0uoemQjbu8aZzGB0+tsE5eWjuFaZib8QDF
 ```
 
 Now open the GitLab web-interface and navigate to `Settings > CI/CD > Variables` from from the page of your repository.
@@ -164,7 +164,7 @@ stages:
 sqa:
   stage: sqa
   image:
-    name: "gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
+    name: "git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest"
     entrypoint: [""]
   before_script:
     - mkdir -p ~/.ssh
@@ -193,7 +193,7 @@ The content of user.email must be identical with what was entered in 5.2.1)
 
 ### Examples
 
-An example of both variants applied at the same time can be found [here](https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance/-/blob/master/.gitlab/ci/sqa.gitlab-ci.yml)
+An example of both variants applied at the same time can be found [here](https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance/-/blob/master/.gitlab/ci/sqa.gitlab-ci.yml)
 
 ## Local
 
@@ -234,7 +234,7 @@ The general syntax looks like the following:
 ```bash
 docker run -v [/ABSOLUTE/PATH/TO/REPO]:/repo \
            -u $(id -u ${USER}):$(id -g ${USER}) \
-           gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
+           git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
            sqa [MODIFIER] run [SERVICE]
 ```
 
@@ -246,7 +246,7 @@ This binds the directory of your project to the docker container.
 
 This makes the user/group of the container the same as the host system ones. 
 
-**`gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest`**
+**`git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest`**
 
 This is the actual path to the image:image-version.
 
@@ -256,7 +256,7 @@ Here the service (and modifier) to run is specified.
 
 To get a list of available services use:
 ```bash
-docker run gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
+docker run git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
            sqa run --help
 ```
 
@@ -266,12 +266,12 @@ Run all services for the project within the directory `~/Projects/volcano_detect
 ```bash
 docker run -v ~/Projects/volcano_detection:/repo \
            -u $(id -u ${USER}):$(id -g ${USER}) \
-           gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
+           git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
            sqa run
 ```
 Get the version of the Software Quality Assurance.
 ```bash
-docker run gitext.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
+docker run git.gfz-potsdam.de:5000/id2/software/services/fair/software-quality-assurance/software-quality-assurance:latest \
            sqa --version
 ```
 

src/setup.py

@@ -61,7 +61,7 @@ setup(
     long_description=read_file("../README.md"),
     long_description_content_type="text/markdown",
     license="GPL-3.0-or-later",
-    url="https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance",
+    url="https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance",
     packages=find_packages(exclude=["tests/.*"]),
     package_data={
         "sqa": [

src/sqa/cli.py

@@ -84,7 +84,7 @@ def main(
 
     Needs a directory to run services on.
     The directory needs to be a git repository_config.
-    Visit 'https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance' for more help.
+    Visit 'https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance' for more help.
     """
     if repository_dir[-1:] == "/":
         repository_dir = repository_dir[:-1]

src/sqa/models.py

@@ -160,7 +160,7 @@ class SQA:
             print("##############################")
             print(
                 "Note: This report is automatically generated by [Software Quality Assurance]"
-                "(https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)"
+                "(https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)"
             )
             print("##############################")
             print("Meta Data")
@@ -180,7 +180,7 @@ class SQA:
                 md_report.write("# Software Quality Report\n")
                 md_report.write(
                     "> **Note:** This report is automatically generated by [Software Quality Assurance]("
-                    "https://gitext.gfz-potsdam.de/software/services/fair/software-quality-assurance)\n\n"
+                    "https://git.gfz-potsdam.de/id2/software/services/fair/software-quality-assurance)\n\n"
                 )
 
                 # write table of content