From 147318e906371f1d5cd5e64fb1beba520ebefc60 Mon Sep 17 00:00:00 2001 From: Roberto Rosario Date: Sat, 30 Nov 2019 17:14:42 -0400 Subject: [PATCH] Add substitutions for common URLs Signed-off-by: Roberto Rosario --- config.env | 2 ++ docs/chapters/development/code_structure.txt | 2 +- docs/chapters/development/contributing.txt | 6 +++--- docs/chapters/development/source_control.txt | 7 ++----- docs/chapters/docker/building.txt | 2 +- docs/chapters/docker/nightly.txt | 2 +- docs/parts/contact.txt | 2 +- docs/parts/faq.txt | 10 ++++++---- 8 files changed, 17 insertions(+), 16 deletions(-) diff --git a/config.env b/config.env index 991d89c377..19a9d1c6a1 100644 --- a/config.env +++ b/config.env @@ -11,3 +11,5 @@ PYTHON_PSYCOPG2_VERSION=2.8.3 PYTHON_PSUTIL_VERSION=5.6.2 PYTHON_REDIS_VERSION=3.2.1 SOURCE_CODE_REPOSITORY=https://gitlab.com/mayan-edms/mayan-edms/ +SOURCE_CODE_GIT=https://gitlab.com/mayan-edms/mayan-edms.git +SOURCE_CODE_ISSUES=https://gitlab.com/mayan-edms/mayan-edms/issues/ diff --git a/docs/chapters/development/code_structure.txt b/docs/chapters/development/code_structure.txt index 4ec4cdc96e..201c9e5122 100644 --- a/docs/chapters/development/code_structure.txt +++ b/docs/chapters/development/code_structure.txt @@ -174,7 +174,7 @@ Steps to deploy a development version .. code-block:: bash - $ git clone https://gitlab.com/mayan-edms/mayan-edms.git + $ git clone |SOURCE_CODE_GIT| $ cd mayan-edms $ git checkout $ virtualenv venv diff --git a/docs/chapters/development/contributing.txt b/docs/chapters/development/contributing.txt index 9d00c15895..cf886e5b7d 100644 --- a/docs/chapters/development/contributing.txt +++ b/docs/chapters/development/contributing.txt @@ -8,11 +8,11 @@ If you have a feature request, suggestion or bug report, please open a new issue on the `GitLab issue tracker`_. To submit patches, please send a merge request on GitLab_. -.. _GitLab: https://gitlab.com/mayan-edms/mayan-edms/ -.. _`GitLab issue tracker`: https://gitlab.com/mayan-edms/mayan-edms/issues +.. _GitLab: |SOURCE_CODE_REPOSITORY| +.. _`GitLab issue tracker`: |SOURCE_CODE_ISSUES| Contributing changes ==================== Follow the latest contributing guidelines outlined here: -https://gitlab.com/mayan-edms/mayan-edms/blob/master/CONTRIBUTING.md +|SOURCE_CODE_REPOSITORY|blob/master/CONTRIBUTING.md diff --git a/docs/chapters/development/source_control.txt b/docs/chapters/development/source_control.txt index 170568288a..8c7c754a1d 100644 --- a/docs/chapters/development/source_control.txt +++ b/docs/chapters/development/source_control.txt @@ -6,7 +6,7 @@ Mayan EDMS source is controlled with Git_. The project is publicly accessible, hosted and can be cloned from **GitLab** using:: - $ git clone https://gitlab.com/mayan-edms/mayan-edms.git + $ git clone |SOURCE_CODE_GIT| Git branch structure @@ -59,7 +59,7 @@ Special branches: Each release is tagged separately using annotated Git tags. When submitting patches, please place your code in its own ``feature/`` branch -prior to opening a Merge Request on GitLab_. +prior to opening a Merge Request on |SOURCE_CODE_ISSUES|. .. _Git: http://git-scm.org .. _`Successful Git Branching Model`: http://nvie.com/posts/a-successful-git-branching-model/ @@ -97,6 +97,3 @@ Commit messages Use:: Document: Fix typo in label description - - -.. _GitLab: https://gitlab.com/mayan-edms/mayan-edms/ diff --git a/docs/chapters/docker/building.txt b/docs/chapters/docker/building.txt index 5e3f7cec46..cce4b9f9c0 100644 --- a/docs/chapters/docker/building.txt +++ b/docs/chapters/docker/building.txt @@ -6,7 +6,7 @@ Building the image Clone the repository with:: - git clone https://gitlab.com/mayan-edms/mayan-edms.git + git clone |SOURCE_CODE_GIT| Change to the directory of the cloned repository:: diff --git a/docs/chapters/docker/nightly.txt b/docs/chapters/docker/nightly.txt index 536545a20f..d65f01e217 100644 --- a/docs/chapters/docker/nightly.txt +++ b/docs/chapters/docker/nightly.txt @@ -7,6 +7,6 @@ produces a resulting Docker image. These are build automatically and their stability is not guaranteed. They should never be used in production. If you want to try out the Docker images the development uses or want a sneak peek at the new features being worked on checkout the container registry at: -https://gitlab.com/mayan-edms/mayan-edms/container_registry +|SOURCE_CODE_REPOSITORY|container_registry diff --git a/docs/parts/contact.txt b/docs/parts/contact.txt index 487314b3c1..8d3fb0b771 100644 --- a/docs/parts/contact.txt +++ b/docs/parts/contact.txt @@ -26,4 +26,4 @@ Bugs/ticket tracker Report bugs with Mayan EDMS or search existing ones using GitLab's `ticket tracker`_. -.. _ticket tracker: https://gitlab.com/mayan-edms/mayan-edms/issues +.. _ticket tracker: |SOURCE_CODE_ISSUES| diff --git a/docs/parts/faq.txt b/docs/parts/faq.txt index 1055b4e1b2..a3bf9eb792 100644 --- a/docs/parts/faq.txt +++ b/docs/parts/faq.txt @@ -26,13 +26,13 @@ questions on a voluntary basis. I found a bug ^^^^^^^^^^^^^ -For bugs, open an issue at https://gitlab.com/mayan-edms/mayan-edms/issues. +For bugs, open an issue at |SOURCE_CODE_ISSUES|. I found a security issue ^^^^^^^^^^^^^^^^^^^^^^^^ -Open an issue at https://gitlab.com/mayan-edms/mayan-edms/issues and mark it as +Open an issue at |SOURCE_CODE_ISSUES| and mark it as Confidential. Allow us at least 48 hours to find and release a fix for the issue before submitting it to the CVE database. @@ -174,8 +174,10 @@ How to do LDAP authentication A sample settings file called ldap_connection_settings.py is included in the contrib/settings/ folder of the repository showing how to setup LDAP -authentication. This file can be found on the web at: https://gitlab.com/mayan-edms/mayan-edms/blob/master/contrib/settings/ldap_connection_settings.py. This is a community contributed file. Use the Python -settings file method to use this file. +authentication. This file can be found on the web at: +|SOURCE_CODE_REPOSITORY|blob/master/contrib/settings/ldap_connection_settings.py. +This is a community contributed file. Use the Python settings file method to +use this file. Operating systems