Skip to content

Commit

Permalink
Releasing v3.1.2
Browse files Browse the repository at this point in the history
* update service versions for v3.1.2

* updating erd and component api links to released versions

* updating collect docs to retrieve released components

* fix reference ui version api link

* Fix link for release
  • Loading branch information
joshzamor authored Jun 23, 2017
1 parent 73a10ac commit 118ce4f
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 85 deletions.
14 changes: 7 additions & 7 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ services:
depends_on: [consul]

reference-ui:
image: openlmis/reference-ui:5.0.2-SNAPSHOT
image: openlmis/reference-ui:5.0.2
env_file: .env
depends_on: [consul]

requisition:
image: openlmis/requisition:4.0.0-SNAPSHOT
image: openlmis/requisition:4.0.0
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml -Dflyway.locations=classpath:db/migration,filesystem:/demo-data'
Expand All @@ -38,7 +38,7 @@ services:
depends_on: [log]

referencedata:
image: openlmis/referencedata:6.0.2-SNAPSHOT
image: openlmis/referencedata:7.0.0
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml -Dflyway.locations=classpath:db/migration,filesystem:/demo-data'
Expand All @@ -48,7 +48,7 @@ services:
depends_on: [log]

auth:
image: openlmis/auth:3.0.3-SNAPSHOT
image: openlmis/auth:3.0.3
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml -Dflyway.locations=classpath:db/migration,filesystem:/demo-data'
Expand All @@ -58,7 +58,7 @@ services:
depends_on: [log]

notification:
image: openlmis/notification:3.0.2-SNAPSHOT
image: openlmis/notification:3.0.2
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml'
Expand All @@ -68,7 +68,7 @@ services:
depends_on: [log]

fulfillment:
image: openlmis/fulfillment:3.1.0-SNAPSHOT
image: openlmis/fulfillment:4.0.0
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml -Dflyway.locations=classpath:db/migration,filesystem:/demo-data'
Expand All @@ -78,7 +78,7 @@ services:
depends_on: [log]

stockmanagement:
image: openlmis/stockmanagement:1.0.0-SNAPSHOT
image: openlmis/stockmanagement:1.0.0-BETA
env_file: .env
environment:
JAVA_OPTS: '-server -Xmx512m -Dlogging.config=/config/log/logback.xml -Dflyway.locations=classpath:db/migration,filesystem:/demo-data'
Expand Down
58 changes: 29 additions & 29 deletions docs/source/collect-docs.py
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
import urllib

#architecture
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/master/docs/application_structure.md", "architecture/applicationStructure.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/master/docs/build_process.md", "architecture/buildProcess.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/master/docs/extention_guide.md", "architecture/extentionGuide.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/docs/application_structure.md", "architecture/applicationStructure.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/docs/build_process.md", "architecture/buildProcess.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/docs/extention_guide.md", "architecture/extentionGuide.md")

#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-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-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-referencedata-ui/master/README.md", "components/referencedataUI.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/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-layout/master/README.md", "components/uiLayout.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment/v4.0.0/README.md", "components/fulfillmentService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition/v5.0.2/README.md", "components/requisitionService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth/v3.0.3/README.md", "components/authService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata/v7.0.0/README.md", "components/referencedataService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement/v1.0.0-beta/README.md", "components/stockmanagementService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.1.2/README.md", "components/templateServiceService.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-reference-ui/v5.0.2/README.md", "components/referenceUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-auth-ui/v5.0.2/README.md", "components/authUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-referencedata-ui/v5.2.0/README.md", "components/referencedataUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-requisition-ui/v5.1.0/README.md", "components/requisitionUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-fulfillment-ui/v5.0.2/README.md", "components/fulfillmentUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-stockmanagement-ui/v1.0.0-beta/README.md", "components/stockmanagementUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/README.md", "components/devUI.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-components/v5.1.0/README.md", "components/uiComponents.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-ui-layout/v5.0.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/dev-ui/master/docs/coding_conventions.md", "conventions/uiCodeConventions.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/master/docs/styleguide.md", "conventions/uiStyleguide.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-template-service/v3.1.2/STYLE-GUIDE.md", "conventions/codeStyleguide.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.1.2/TESTING.md", "conventions/testing.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.1.2/ERROR_HANDLING.md", "conventions/errorHandling.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/docs/coding_conventions.md", "conventions/uiCodeConventions.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/dev-ui/v4/docs/styleguide.md", "conventions/uiStyleguide.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-template-service/v3.1.2/LICENSE-HEADER.md", "conventions/licenseHeader.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/deployment/README.md", "deployment/demoAndCiJenkins.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.1.2/deploymentTopology.md", "deployment/topology.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.1.2/provision/Provision-single-host.md", "deployment/provisionSingleHost.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.1.2/provision/Provision-swarm-With-ELB.md", "deployment/provisionSwarmWithELB.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.1.2/provision/Provision-swarm-With-Elastic-ip.md", "deployment/provisionSwarmWithElasticIp.md")
urllib.urlretrieve("https://raw.githubusercontent.com/OpenLMIS/openlmis-deployment/v3.1.2/deployment/README.md", "deployment/demoAndCiJenkins.md")
3 changes: 1 addition & 2 deletions docs/source/components/erd-auth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Auth ERD

ERD schema of Auth service:

* `Live ERD <http://ci.openlmis.org/erd-auth/>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-auth-erd-generation/lastSuccessfulBuild/artifact/erd-auth.zip>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-auth-erd-generation/201/artifact/erd-auth.zip>`_
3 changes: 1 addition & 2 deletions docs/source/components/erd-fulfillment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Fulfillment ERD

ERD schema of Fulfillment service:

* `Live ERD <http://ci.openlmis.org/erd-fulfillment/>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-fulfillment-erd-generation/lastSuccessfulBuild/artifact/erd-fulfillment.zip>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-fulfillment-erd-generation/247/artifact/erd-fulfillment.zip>`_
3 changes: 1 addition & 2 deletions docs/source/components/erd-referencedata.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Reference Data ERD

ERD schema of Reference Data service:

* `Live ERD <http://ci.openlmis.org/erd-referencedata/>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-referencedata-erd-generation/lastSuccessfulBuild/artifact/erd-referencedata.zip>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-referencedata-erd-generation/617/artifact/erd-referencedata.zip>`_
8 changes: 1 addition & 7 deletions docs/source/components/erd-requisition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,4 @@ Requisition ERD

ERD schema of Requisition service:

* `Live ERD <http://ci.openlmis.org/erd-requisition/>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-requisition-erd-generation/lastSuccessfulBuild/artifact/erd-requisition.zip>`_





* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-requisition-erd-generation/1144/artifact/erd-requisition.zip>`_
3 changes: 1 addition & 2 deletions docs/source/components/erd-stockmanagement.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Stock Management ERD

ERD schema of Stock Management service:

* `Live ERD <http://ci.openlmis.org/erd-stockmanagement/>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-stockmanagement-erd-generation/lastSuccessfulBuild/artifact/erd-stockmanagement.zip>`_
* `Zip ERD <http://build.openlmis.org/job/OpenLMIS-stockmanagement-erd-generation/262/artifact/erd-stockmanagement.zip>`_
40 changes: 8 additions & 32 deletions docs/source/components/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,6 @@ Components
How to use Component Documentation
**********************************

Logging in with the Live Documentation
======================================

The live documentation links connect directly to our Swagger docs on our CI server. To use the API you'll first need to get an
access token from the Auth service, and then you'll need to give that token when using one of the RESTful operations.

Obtaining an access token:

1. goto the Auth service's `POST /api/oauth/token <https://test.openlmis.org/auth/docs/#!/default/post_api_oauth_token>`_
2. click on :code:`Authorize` in the top right of the page
3. in the box that has popped-up, enter username :code:`user-client` and password :code:`changeme`
4. click :code:`Authorize` under :code:`password`
5. enter the username :code:`administrator` and password :code:`password`
6. click :code:`Try it out!`
7. In the :code:`Response body` box, copy the UUID. e.g. :code:`"access_token": "a93bcab7-aaf5-43fe-9301-76c526698898"` copy :code:`a93bcab7-aaf5-43fe-9301-76c526698898` to use later.
8. Paste the UUID you just copied into any endpoint's :code:`access_token` field.

****
Auth
****
Expand All @@ -32,8 +15,7 @@ Security credentials, Authentication and Authorization. Uses OAuth2.
- `Auth Service <authService.html>`_
- `Auth UI <authUI.html>`_
- `Auth ERD <erd-auth.html>`_
- `Live Documentation for Auth API <http://test.openlmis.org/auth/docs/#/default>`_
- `Static Documentation for Auth API <http://build.openlmis.org/job/OpenLMIS-auth-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_
- `Static Documentation for Auth API <http://build.openlmis.org/job/OpenLMIS-auth-service/234/artifact/build/resources/main/api-definition.html>`_

*******************
Fulfillment Service
Expand All @@ -44,17 +26,15 @@ Includes the basics of fulfillment.
- `Fulfillment Service <fulfillmentService.html>`_
- `Fulfillment UI <fulfillmentUI.html>`_
- `Fulfillment ERD <erd-fulfillment.html>`_
- `Live Documentation for Fulfillment API <http://test.openlmis.org/fulfillment/docs/#/default>`_
- `Static Documentation for Fulfillment API <http://build.openlmis.org/job/OpenLMIS-fulfillment-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_
- `Static Documentation for Fulfillment API <http://build.openlmis.org/job/OpenLMIS-fulfillment-service/292/artifact/build/resources/main/api-definition.html>`_

********************
Notification Service
********************

Notifying users when their attention is needed.

- `Live Documentation for Notification API <http://test.openlmis.org/notification/docs/#/default>`_
- `Static Documentation for Notification API <http://build.openlmis.org/job/OpenLMIS-notification-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_
- `Static Documentation for Notification API <http://build.openlmis.org/job/OpenLMIS-notification-service/108/artifact/build/resources/main/api-definition.html>`_

**********************
Reference Data Service
Expand All @@ -65,17 +45,16 @@ Provides the reference data for the rest of the processes: facilities, programs,
- `Reference Data Service <referencedataService.html>`_
- `Reference Data UI <referencedataUI.html>`_
- `Reference Data ERD <erd-referencedata.html>`_
- `Live Documentation for Reference Data API <http://test.openlmis.org/referencedata/docs/#/default>`_
- `Static Documentation for Reference Data API <http://build.openlmis.org/job/OpenLMIS-referencedata-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_
- `Static Documentation for Reference Data API <http://build.openlmis.org/job/OpenLMIS-referencedata-service/781/artifact/build/resources/main/api-definition.html>`_

************
Reference UI
************

The Reference UI compiles together all the assets that make up the OpenLMIS-UI. See the `build process documentation <../architecture/buildProcess.html>`_ to understand exactly how the UI is compiled.

- `UI Styleguide <http://build.openlmis.org/job/OpenLMIS-reference-ui/lastSuccessfulBuild/artifact/build/styleguide/index.html#!/login>`_
- `Javascript Documentation <http://build.openlmis.org/job/OpenLMIS-reference-ui/lastSuccessfulBuild/artifact/build/docs/index.html#/api>`_
- `UI Styleguide <http://build.openlmis.org/job/OpenLMIS-reference-ui/v5.0.2/artifact/build/styleguide/index.html#!/login>`_
- `Javascript Documentation <http://build.openlmis.org/job/OpenLMIS-reference-ui/v5.0.2/artifact/build/docs/index.html#/api>`_
- `Reference UI <referenceUI.html>`_
- `UI Layout <uiLayout.html>`_
- `UI Components <uiComponents.html>`_
Expand All @@ -90,8 +69,7 @@ Requisition (pull) based replenishment process.
- `Requisition Service <requisitionService.html>`_
- `Requisition UI <requisitionUI.html>`_
- `Requisition ERD <erd-requisition.html>`_
- `Live Documentation for Requisition API <http://test.openlmis.org/requisition/docs/#/default>`_
- `Static Documentation for Requisition API <http://build.openlmis.org/job/OpenLMIS-requisition-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_
- `Static Documentation for Requisition API <http://build.openlmis.org/job/OpenLMIS-requisition-service/1545/artifact/build/resources/main/api-definition.html>`_

*************************
Stock Management Service
Expand All @@ -102,6 +80,4 @@ Electronic stock cards.
- `Stock Management Service <stockmanagementService.html>`_
- `Stock Management UI <stockmanagementUI.html>`_
- `Stock Management ERD <erd-stockmanagement.html>`_
- `Live Documentation for Stock Management API <http://test.openlmis.org/stockmanagement/docs/#/default>`_
- `Static Documentation for Stock Management API <http://build.openlmis.org/job/OpenLMIS-stockmanagement-service/lastSuccessfulBuild/artifact/build/resources/main/api-definition.html>`_

- `Static Documentation for Stock Management API <http://build.openlmis.org/job/OpenLMIS-stockmanagement-service/299/artifact/build/resources/main/api-definition.html>`_
4 changes: 2 additions & 2 deletions docs/source/conventions/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Service Conventions

UI Conventions
==============
See the `OpenLMIS-UI Styleguide <build.openlmis.org/job/OpenLMIS-reference-ui/lastSuccessfulBuild/artifact/build/styleguide/index.html>`_ for documentation about how components look and function.
See the `OpenLMIS-UI Styleguide <build.openlmis.org/job/OpenLMIS-reference-ui/v5.0.2/artifact/build/styleguide/index.html>`_ for documentation about how components look and function.

.. toctree::
:maxdepth: 1

uiStyleguide
uiCodeConventions

0 comments on commit 118ce4f

Please sign in to comment.