From: Thanh Ha Date: Fri, 15 Jun 2018 19:48:48 +0000 (-0400) Subject: Switch instances of PROJECT_DOMAIN to example.org X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F54%2F11354%2F2;p=releng%2Fdocs.git Switch instances of PROJECT_DOMAIN to example.org example.org reads better and we seem to have a mixed use of PROJECT_DOMAIN vs example.org, let's just switch to the one format for consistency. Change-Id: I556c285220bf366b7da9cf0545937610978545bd Signed-off-by: Thanh Ha --- diff --git a/docs/conf.py b/docs/conf.py index 859ba7e..9c658db 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,6 @@ from docs_conf.conf import * intersphinx_mapping['ansible'] = ('https://docs.ansible.com/ansible/latest/', None) linkcheck_ignore = [ - 'http.*PROJECT_DOMAIN.*', 'https://gerrit.linuxfoundation.org/infra/releng/docs-conf', 'https://gerrit.linuxfoundation.org/infra/#/settings/http-password', 'https://jenkins.acumos.org.*', diff --git a/docs/jenkins.rst b/docs/jenkins.rst index 15aea54..0bc7038 100644 --- a/docs/jenkins.rst +++ b/docs/jenkins.rst @@ -441,10 +441,10 @@ configuration gets managed through code using JJB through the ci-management or releng/builder repos. To access the Jenkins Production URL for any project use: -``https://jenkins.PROJECT_DOMAIN`` +``https://jenkins.example.org`` Similarily, the project's corresponding Jenkins Sandbox URL would be: -``https://jenkins.PROJECT_DOMAIN/sandbox`` +``https://jenkins.example.org/sandbox`` Any users with an LFID can access the Jenkins Production site, but for Jenkins Sandbox please request an access. To do so, refer to the section diff --git a/docs/nexus2.rst b/docs/nexus2.rst index dbcb260..795d3d1 100644 --- a/docs/nexus2.rst +++ b/docs/nexus2.rst @@ -13,7 +13,7 @@ It helps organizing dependencies and releases. https://help.sonatype.com/repomanager2 To access Nexus 2 for a particular project, use URL: -``https://nexus.PROJECT_DOMAIN`` +``https://nexus.example.org`` .. image:: _static/nexus2-ui.png :alt: Nexus Repository Manager 2 main view. @@ -28,7 +28,7 @@ Other users can browse the repositories and proxies anonymously. :align: center Alternately, users can access the repositories outside the GUI using the URL: -``https://nexus.PROJECT_DOMAIN/content/repositories/`` +``https://nexus.example.org/content/repositories/`` .. image:: _static/nexus2-content.png :alt: Nexus Repository Manager 2 content view. diff --git a/docs/project-documentation.rst b/docs/project-documentation.rst index 63ccc18..e430e79 100644 --- a/docs/project-documentation.rst +++ b/docs/project-documentation.rst @@ -31,10 +31,10 @@ Framework Typically every project like ONAP, OpenDaylight, OPNFV, etc... have a "documentation" project. This project provides a gateway to all documentation for the project and typically is the index page of any project's -http://docs.PROJECT_DOMAIN url. +https://docs.example.org url. Project-specific documentation will configure as subprojects in ReadTheDocs and -are available at http://docs.PROJECT_DOMAIN/projects/PROJECT +are available at https://docs.example.org/projects/PROJECT Linking between projects are possible via intersphinx linking. @@ -133,7 +133,7 @@ ReadTheDocs know where to pull your docs to build from. If this project is not the main documentation project then it needs to be setup as a sub-project of the main documentation project. This will create a subproject link for your project under - http://docs.PROJECT_DOMAIN/projects/YOUR_PROJECT + https://docs.example.org/projects/YOUR_PROJECT .. note::