From d1eb1a66f0e6a2da5d88d79306f4c194b7f71952 Mon Sep 17 00:00:00 2001 From: Chongsun Ahn Date: Fri, 17 Aug 2018 18:06:55 -0700 Subject: [PATCH] Update documentation to v3.4 versions To 3.4 versions of documentation, and 3.4 versions of build artifacts. --- docs/source/collect-docs.py | 80 +++++++++---------- docs/source/components/erd-auth.rst | 2 +- docs/source/components/erd-cce.rst | 2 +- docs/source/components/erd-fulfillment.rst | 2 +- docs/source/components/erd-notification.rst | 2 +- docs/source/components/erd-referencedata.rst | 2 +- docs/source/components/erd-report.rst | 2 +- docs/source/components/erd-requisition.rst | 2 +- .../source/components/erd-stockmanagement.rst | 2 +- docs/source/components/index.rst | 20 ++--- 10 files changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/source/collect-docs.py b/docs/source/collect-docs.py index 95bf8348..ea217ef0 100644 --- a/docs/source/collect-docs.py +++ b/docs/source/collect-docs.py @@ -1,47 +1,47 @@ import urllib #components -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment/master/README.md", "components/fulfillmentService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition/master/README.md", "components/requisitionService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth/master/README.md", "components/authService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth/master/DESIGN.md", "components/authServiceDesign.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-cce/master/README.md", "components/cceService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-notification/master/README.md", "components/notificationService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata/master/README.md", "components/referencedataService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement/master/README.md", "components/stockmanagementService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-report/master/README.md", "components/reportService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/master/README.md", "components/templateServiceService.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-reference-ui/master/README.md", "components/referenceUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth-ui/master/README.md", "components/authUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-cce-ui/master/README.md", "components/cceUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata-ui/master/README.md", "components/referencedataUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-report-ui/master/README.md", "components/reportUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition-ui/master/README.md", "components/requisitionUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment-ui/master/README.md", "components/fulfillmentUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement-ui/master/README.md", "components/stockmanagementUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/master/README.md", "components/devUI.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/README.md", "components/uiComponents.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/index.md", "components/uiOverview.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/extension_guide.md", "components/uiExtensionGuide.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-layout/master/README.md", "components/uiLayout.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment/v7.0.1/README.md", "components/fulfillmentService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition/v7.0.0/README.md", "components/requisitionService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth/v4.0.0/README.md", "components/authService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth/v4.0.0/DESIGN.md", "components/authServiceDesign.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-cce/v1.0.1/README.md", "components/cceService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-notification/v4.0.0/README.md", "components/notificationService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata/v11.0.0/README.md", "components/referencedataService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement/v3.1.0/README.md", "components/stockmanagementService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-report/v1.1.1/README.md", "components/reportService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.4.0/README.md", "components/templateServiceService.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-reference-ui/v5.1.0/README.md", "components/referenceUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth-ui/v6.1.1/README.md", "components/authUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-cce-ui/v1.0.1/README.md", "components/cceUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata-ui/v5.4.0/README.md", "components/referencedataUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-report-ui/v5.0.6/README.md", "components/reportUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition-ui/v5.4.0/README.md", "components/requisitionUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment-ui/v6.0.1/README.md", "components/fulfillmentUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement-ui/v2.0.0/README.md", "components/stockmanagementUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v8.0.0/README.md", "components/devUI.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/README.md", "components/uiComponents.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/index.md", "components/uiOverview.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/extension_guide.md", "components/uiExtensionGuide.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-layout/v5.1.1/README.md", "components/uiLayout.md") #conventions -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/master/STYLE-GUIDE.md", "conventions/codeStyleguide.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/master/TESTING.md", "conventions/testing.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/master/ERROR_HANDLING.md", "conventions/errorHandling.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/master/LICENSE-HEADER.md", "conventions/licenseHeader.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/conventions.md", "conventions/uiConventions.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/conventions-angularjs.md", "conventions/uiAngularjs.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/conventions-javascript.md", "conventions/uiJavascript.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/conventions-markup.md", "conventions/uiMarkup.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/conventions-testing.md", "conventions/uiTesting.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/information-architecture.md", "conventions/uiInformationArchitecture.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/master/docs/performance.md", "conventions/uiPerformance.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.4.0/STYLE-GUIDE.md", "conventions/codeStyleguide.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.4.0/TESTING.md", "conventions/testing.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.4.0/ERROR_HANDLING.md", "conventions/errorHandling.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.4.0/LICENSE-HEADER.md", "conventions/licenseHeader.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/conventions.md", "conventions/uiConventions.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/conventions-angularjs.md", "conventions/uiAngularjs.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/conventions-javascript.md", "conventions/uiJavascript.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/conventions-markup.md", "conventions/uiMarkup.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/conventions-testing.md", "conventions/uiTesting.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/information-architecture.md", "conventions/uiInformationArchitecture.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v6.0.0/docs/performance.md", "conventions/uiPerformance.md") # deployment -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/deploymentTopology.md", "deployment/topology.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/provision/Provision-single-host.md", "deployment/provisionSingleHost.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/provision/Provision-swarm-With-ELB.md", "deployment/provisionSwarmWithELB.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/provision/Provision-swarm-With-Elastic-ip.md", "deployment/provisionSwarmWithElasticIp.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/provision/RDS-configuration.md", "deployment/rdsConfiguration.md") -urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/master/deployment/README.md", "deployment/demoAndCiJenkins.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/deploymentTopology.md", "deployment/topology.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/provision/Provision-single-host.md", "deployment/provisionSingleHost.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/provision/Provision-swarm-With-ELB.md", "deployment/provisionSwarmWithELB.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/provision/Provision-swarm-With-Elastic-ip.md", "deployment/provisionSwarmWithElasticIp.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/provision/RDS-configuration.md", "deployment/rdsConfiguration.md") +urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.4.0/deployment/README.md", "deployment/demoAndCiJenkins.md") diff --git a/docs/source/components/erd-auth.rst b/docs/source/components/erd-auth.rst index 15e85e85..9216e18b 100644 --- a/docs/source/components/erd-auth.rst +++ b/docs/source/components/erd-auth.rst @@ -5,4 +5,4 @@ Auth ERD ERD schema of Auth service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-cce.rst b/docs/source/components/erd-cce.rst index 9fe02567..78a913fd 100644 --- a/docs/source/components/erd-cce.rst +++ b/docs/source/components/erd-cce.rst @@ -5,4 +5,4 @@ CCE ERD ERD schema of CCE service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-fulfillment.rst b/docs/source/components/erd-fulfillment.rst index bfaf66de..eb633cb1 100644 --- a/docs/source/components/erd-fulfillment.rst +++ b/docs/source/components/erd-fulfillment.rst @@ -5,4 +5,4 @@ Fulfillment ERD ERD schema of Fulfillment service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-notification.rst b/docs/source/components/erd-notification.rst index 49efd1d8..878f102a 100644 --- a/docs/source/components/erd-notification.rst +++ b/docs/source/components/erd-notification.rst @@ -5,4 +5,4 @@ Notification ERD ERD schema of Notification service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-referencedata.rst b/docs/source/components/erd-referencedata.rst index d8f65855..e596c2b6 100644 --- a/docs/source/components/erd-referencedata.rst +++ b/docs/source/components/erd-referencedata.rst @@ -5,4 +5,4 @@ Reference Data ERD ERD schema of Reference Data service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-report.rst b/docs/source/components/erd-report.rst index 1cb36296..8e7d5997 100644 --- a/docs/source/components/erd-report.rst +++ b/docs/source/components/erd-report.rst @@ -5,4 +5,4 @@ Report ERD ERD schema of Report service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-requisition.rst b/docs/source/components/erd-requisition.rst index e49dace5..d3076bfd 100644 --- a/docs/source/components/erd-requisition.rst +++ b/docs/source/components/erd-requisition.rst @@ -5,4 +5,4 @@ Requisition ERD ERD schema of Requisition service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/erd-stockmanagement.rst b/docs/source/components/erd-stockmanagement.rst index 8f454b3e..a36f5be0 100644 --- a/docs/source/components/erd-stockmanagement.rst +++ b/docs/source/components/erd-stockmanagement.rst @@ -5,4 +5,4 @@ Stock Management ERD ERD schema of Stock Management service: * `Live ERD `_ -* `Zip ERD `_ +* `Zip ERD `_ diff --git a/docs/source/components/index.rst b/docs/source/components/index.rst index 9c25d682..dce32b4a 100644 --- a/docs/source/components/index.rst +++ b/docs/source/components/index.rst @@ -43,7 +43,7 @@ Auth Service works with the Reference Data service to handle role-based access c - `Auth Service Design `_ - `Auth Service ERD `_ - `Live Documentation for Auth API `_ -- `Static Documentation for Auth API `_ +- `Static Documentation for Auth API `_ ******************* Fulfillment Service @@ -57,7 +57,7 @@ warehouse systems. - `Fulfillment Service README `_ - `Fulfillment ERD `_ - `Live Documentation for Fulfillment API `_ -- `Static Documentation for Fulfillment API `_ +- `Static Documentation for Fulfillment API `_ *********** CCE Service @@ -71,7 +71,7 @@ inventory (tracking equipment at locations) and functional status. The catalog c - `CCE Service README `_ - `CCE ERD `_ - `Live Documentation for CCE API `_ -- `Static Documentation for CCE API `_ +- `Static Documentation for CCE API `_ ******************** Notification Service @@ -84,7 +84,7 @@ email notifications to users. The Notification Service does not provide a web UI - `Notification Service README `_ - `Notification ERD `_ - `Live Documentation for Notification API `_ -- `Static Documentation for Notification API `_ +- `Static Documentation for Notification API `_ ********************** Reference Data Service @@ -100,7 +100,7 @@ or can be added and edited individually using the Reference Data Service APIs. - `Reference Data Service README `_ - `Reference Data ERD `_ - `Live Documentation for Reference Data API `_ -- `Static Documentation for Reference Data API `_ +- `Static Documentation for Reference Data API `_ ************ Reference UI @@ -113,7 +113,7 @@ deployment for implementers to use. Learn about the Reference UI: - `OpenLMIS UI Overview `_ describes the UI architecture and tooling -- `UI Styleguide `_ +- `UI Styleguide `_ shows examples and best practices for many re-usable components - `Dev UI `_ documents the build process and commands used by all UI components @@ -121,7 +121,7 @@ Coding and Customizing the UI: - `UI Extension Guide `_ - UI :doc:`../conventions/index` -- `Javascript Documentation `_ +- `Javascript Documentation `_ UI Repositories: @@ -163,7 +163,7 @@ report storage, generation (including in PDF format), and seeding rights that us - `Report Service README `_ - `Report ERD `_ - `Live Documentation for Report API `_ -- `Static Documentation for Report API `_ +- `Static Documentation for Report API `_ ******************* Requisition Service @@ -179,7 +179,7 @@ programs and facilities. - `Requisition Service README `_ - `Requisition ERD `_ - `Live Documentation for Requisition API `_ -- `Static Documentation for Requisition API `_ +- `Static Documentation for Requisition API `_ ************************ Stock Management Service @@ -192,7 +192,7 @@ recording stock transactions over time. - `Stock Management Service README `_ - `Stock Management ERD `_ - `Live Documentation for Stock Management API `_ -- `Static Documentation for Stock Management API `_ +- `Static Documentation for Stock Management API `_ ******************************** Reporting and Analytics Platform