Skip to content

Commit b52fd02

Browse files
akmadakmad
committed
Added release notes for version 3.12.0.
1 parent 7b12a9e commit b52fd02

File tree

3 files changed

+236
-0
lines changed

3 files changed

+236
-0
lines changed

‎docs/source/releases/UI-Performance-3.12.png

31.8 KB
Loading

‎docs/source/releases/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ To download a release, please visit `GitHub <https://github.com/OpenLMIS/openlmi
77
.. toctree::
88
:maxdepth: 1
99

10+
openlmis-ref-distro-v3.12.0
1011
openlmis-ref-distro-v3.11.0
1112
openlmis-ref-distro-v3.10.0
1213
openlmis-ref-distro-v3.9.0

‎docs/source/releases/openlmis-ref-distro-v3.12.0.rst

+235
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,235 @@
1+
====================================
2+
3.12.0 Release Notes - October 29, 2021
3+
====================================
4+
5+
Status: Stable
6+
===============
7+
8+
3.12.0 is a stable release, and all users of `OpenLMIS version 3
9+
<https://openlmis.atlassian.net/wiki/spaces/OP/pages/88670325/3.0.0+Release+-+1+March+2017>`_ are
10+
encouraged to adopt it.
11+
12+
Release Notes
13+
=============
14+
The OpenLMIS Community is excited to announce the **3.12.0 release** of OpenLMIS! It is another major milestone in the version 3 `re-architecture <https://openlmis.atlassian.net/wiki/display/OP/Re-Architecture>`_ that allows more functionality to be shared among the community of OpenLMIS implementers.
15+
16+
For a full list of features and bug-fixes since 3.11.0, see `OpenLMIS 3.12.0 Jira tickets
17+
<https://openlmis.atlassian.net/issues/?jql=status%3DDone%20AND%20project%3DOLMIS%20AND%20fixVersion%3D3.12%20and%20type!%3DTest%20and%20type!%3DEpic%20ORDER%20BY%20%22Epic%20Link%22%20asc%2C%20key%20ASC>`_.
18+
19+
For information about future planned releases, see the `Living Product Roadmap
20+
<https://openlmis.atlassian.net/wiki/display/OP/Living+Product+Roadmap>`_. Pull requests and
21+
`contributions <http://docs.openlmis.org/en/latest/contribute/contributionGuide.html>`_ are welcome.
22+
23+
Compatibility
24+
-------------
25+
26+
Unless noted here, all other changes to OpenLMIS 3.x are backwards-compatible. All changes to data
27+
or schemas include automated migrations from previous versions back to version 3.0.1. All new or
28+
altered functionality is listed in the sections below for New Features and Changes to Existing
29+
Functionality.
30+
31+
Upgrading from Older Versions
32+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
34+
If you are upgrading from OpenLMIS 3.0.x or 3.1.x (without first upgrading to 3.2.x), please review the `3.2.0
35+
Release Notes <http://docs.openlmis.org/en/latest/releases/openlmis-ref-distro-v3.2.0.html>`_ for
36+
important compatibility information about a required PostgreSQL extension and data migrations.
37+
38+
For information about upgrade paths from OpenLMIS 1 and 2 to version 3, see the `3.0.0 Release
39+
Notes <https://openlmis.atlassian.net/wiki/spaces/OP/pages/88670325/3.0.0+Release+-+1+March+2017>`_.
40+
41+
Download or View on GitHub
42+
--------------------------
43+
44+
`OpenLMIS Reference Distribution 3.12.0
45+
<https://github.com/OpenLMIS/openlmis-ref-distro/releases/tag/v3.12.0>`_
46+
47+
Known Bugs
48+
==========
49+
50+
Bug reports are collected in Jira for troubleshooting, analysis and resolution on an ongoing basis. See `OpenLMIS 3.12.0
51+
Bugs <https://openlmis.atlassian.net/issues/?jql=project%20%3D%20OLMIS%20AND%20issuetype%20%3D%20Bug%20AND%20affectedVersion%20%3D%203.12%20order%20by%20priority%20DESC%2C%20status%20ASC%2C%20key%20ASC>`_ for the current list of known bugs.
52+
53+
To report a bug, see `Reporting Bugs
54+
<http://docs.openlmis.org/en/latest/contribute/contributionGuide.html#reporting-bugs>`_.
55+
56+
New Features
57+
============
58+
The OpenLMIS community focused on the following work in version 3.12.0:
59+
60+
- **One Network Integration** OpenLMIS will now integration with the One Netowrk platform in a one-way data sync from OpenLMIS to One Network. This is the foundation of a more in-depth integration that will be developed as partners start to utilize this data flow.
61+
- **OpenLMIS Android Application** A first-party OpenLMIS mobile application has been created for the Physical Inventory process. While the application is fully functional, it is still in the early stages of development and expected to be extended in coming releases.
62+
63+
Reference the `3.12 epics <https://openlmis.atlassian.net/issues/?filter=20614&jql=issuetype%20%3D%20Epic%20AND%20status%20in%20(Done%2C%20%22In%20Progress%22)%20AND%20fixVersion%20%3D%203.12%20ORDER%20BY%20created%20DESC>`_ for more details.
64+
65+
Changes to Existing Functionality
66+
=================================
67+
68+
See `all 3.12 issues tagged 'UIChange' in Jira <https://openlmis.atlassian.net/issues/?jql=status%3DDone%20AND%20project%3DOLMIS%20AND%20fixVersion%3D3.12%20and%20type!%3DTest%20and%20type!%3DEpic%20and%20labels%20IN%20(UIChange)%20ORDER%20BY%20type%20ASC%2C%20priority%20DESC%2C%20key%20ASC>`_.
69+
70+
API Changes
71+
===========
72+
73+
API changes can be found in each service CHANGELOG.md file, found in the root directory of the service repository.
74+
75+
Performance
76+
========================
77+
78+
As expected, the performance of version 3.12.0 is similar to version 3.11.0. Performance remains a high priority for the OpenLMIS community and we will be revisiting the overall performance picture in upcoming releases.
79+
80+
OpenLMIS conducted manual performance tests of the same user workflows with the same test data we used in testing v3.2.1 to establish that last-mile performance characteristics have been retained at a minimum. For details on the test results and process, please see `this wiki page <https://openlmis.atlassian.net/wiki/spaces/OP/pages/116949318/Performance+Metrics>`_.
81+
82+
The following chart displays the UI loading times in seconds for 3.9, 3.10, 3.11, and 3.12 using the same test data.
83+
84+
.. image:: UI-Performance-3.12.png
85+
:alt: UI Load Times for 3.9 through 3.12
86+
87+
Test Coverage
88+
=============
89+
90+
OpenLMIS 3.12.0 was tested using the established OpenLMIS Release Candidate process. As part of this process, full manual test cycles were executed for each release candidate published. Any critical or blocker bugs found during the release candidate were resolved in a bug fix cycle with a full manual test cycle executed before releasing the final version 3.12.0. Manual tests were conducted using a set of 99 QAlity tests tracked in Jira and 7 manual tests for reporting. For more details about test executions and bugs found for this release please see `the 3.1! QA Release and Bug Triage wiki page <https://openlmis.atlassian.net/wiki/spaces/OP/pages/1757249566/The+3.11+Regression+and+Release+Candidate+Test+Plan>`_.
91+
92+
All Changes by Component
93+
========================
94+
95+
Version 3.12.0 of the Reference Distribution contains updated versions of the components listed
96+
below. The Reference Distribution bundles these component together using Docker to create a complete
97+
OpenLMIS instance. Each component has its own own public GitHub repository (source code) and
98+
DockerHub repository (release image). The Reference Distribution and components are versioned
99+
independently; for details see `Versioning and Releasing
100+
<http://docs.openlmis.org/en/latest/conventions/versioningReleasing.html>`_.
101+
102+
Auth Service 4.3.2
103+
------------------
104+
105+
`Auth CHANGELOG <https://github.com/OpenLMIS/openlmis-auth/blob/master/CHANGELOG.md>`_
106+
107+
CCE Service 1.3.1
108+
-----------------
109+
110+
`CCE CHANGELOG <https://github.com/OpenLMIS/openlmis-cce/blob/master/CHANGELOG.md>`_
111+
112+
Fulfillment Service 9.0.2
113+
-------------------------
114+
115+
`Fulfillment CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment/blob/master/CHANGELOG.md>`_
116+
117+
Notification Service 4.3.2
118+
--------------------------
119+
120+
`Notification CHANGELOG <https://github.com/OpenLMIS/openlmis-notification/blob/master/CHANGELOG.md>`_
121+
122+
Reference Data Service 15.2.2
123+
-----------------------------
124+
125+
`ReferenceData CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata/blob/master/CHANGELOG.md>`_
126+
127+
Report Service 1.2.1
128+
--------------------
129+
130+
This service is intended to provide reporting functionality for other components to use. Built-in
131+
reports in OpenLMIS 3.4.0 are still powered by their own services. In future releases, they may be
132+
migrated to a new version of this centralized report service.
133+
134+
**Warning**: Developers should take note that the design of this service will be changing with
135+
future releases. Developers and implementers are discouraged from using this 1.2.x version to build
136+
additional reports.
137+
138+
`Report CHANGELOG <https://github.com/OpenLMIS/openlmis-report/blob/master/CHANGELOG.md>`_
139+
140+
Requisition Service 8.3.3
141+
-------------------------
142+
143+
`Requisition CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition/blob/master/CHANGELOG.md>`_
144+
145+
Stock Management 5.1.4
146+
----------------------
147+
148+
`Stock Management CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement/blob/master/CHANGELOG.md>`_
149+
150+
Reference UI 5.2.1
151+
------------------
152+
153+
`The Reference UI <https://github.com/OpenLMIS/openlmis-reference-ui/>`_
154+
is the web-based user interface for the OpenLMIS Reference Distribution. This user interface is
155+
a single page web application that is optimized for offline and low-bandwidth environments.
156+
The Reference UI is compiled together from module UI modules using Docker compose along with the
157+
OpenLMIS dev-ui. UI modules included in the Reference UI are:
158+
159+
Reference Data-UI 5.6.6
160+
~~~~~~~~~~~~~~~~~~~~~~~
161+
162+
`ReferenceData-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-referencedata-ui/blob/master/CHANGELOG.md>`_
163+
164+
Auth-UI 6.2.7
165+
~~~~~~~~~~~~~
166+
167+
`Auth-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-auth-ui/blob/master/CHANGELOG.md>`_
168+
169+
CCE-UI 1.1.0
170+
~~~~~~~~~~~~
171+
172+
`CCE-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-cce-ui/blob/master/CHANGELOG.md>`_
173+
174+
Fulfillment-UI 6.1.0
175+
~~~~~~~~~~~~~~~~~~~~
176+
177+
`Fulfillment-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-fulfillment-ui/blob/master/CHANGELOG.md>`_
178+
179+
Report-UI 5.2.7
180+
~~~~~~~~~~~~~~~
181+
182+
`Report-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-report-ui/blob/master/CHANGELOG.md>`_
183+
184+
Requisition-UI 7.0.6
185+
~~~~~~~~~~~~~~~~~~~~
186+
187+
`Requisition-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-requisition-ui/blob/master/CHANGELOG.md>`_
188+
189+
Stock Management-UI 2.1.0
190+
~~~~~~~~~~~~~~~~~~~~~~~~~
191+
192+
`Stock Management-UI CHANGELOG <https://github.com/OpenLMIS/openlmis-stockmanagement-ui/blob/master/CHANGELOG.md>`_
193+
194+
UI-Components 7.2.6
195+
~~~~~~~~~~~~~~~~~~~
196+
197+
`UI-Components CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-components/blob/master/CHANGELOG.md>`_
198+
199+
UI-Layout 5.2.0
200+
~~~~~~~~~~~~~~~
201+
202+
`UI-Layout CHANGELOG <https://github.com/OpenLMIS/openlmis-ui-layout/blob/master/CHANGELOG.md>`_
203+
204+
Dev UI 9.0.3
205+
~~~~~~~~~~~~
206+
207+
The `Dev-UI CHANGLOG <https://github.com/OpenLMIS/dev-ui/blob/master/CHANGELOG.md>`_
208+
209+
Components with No Changes
210+
==========================
211+
212+
The components that have not changed are:
213+
214+
- `Service Util <https://github.com/OpenLMIS/openlmis-service-util>`_
215+
- `Logging Service <https://github.com/OpenLMIS/openlmis-rsyslog>`_
216+
- Consul-friendly distribution of `nginx <https://github.com/OpenLMIS/openlmis-nginx>`_
217+
- Docker `Postgres 9.6-postgis image <https://github.com/OpenLMIS/postgres>`_
218+
- Docker `scalyr image <https://github.com/OpenLMIS/openlmis-scalyr>`_
219+
220+
Contributions
221+
=============
222+
223+
Many organizations and individuals around the world have contributed to OpenLMIS version 3 by
224+
serving on our committees (Governance, Product and Technical), requesting improvements, suggesting
225+
features and writing code and documentation. Please visit our GitHub repos to see the list of
226+
individual contributors on the OpenLMIS codebase. If anyone who contributed in GitHub is missing,
227+
please contact the Community Manager.
228+
229+
Thanks to the Malawi implementation team who has continued to contribute a number of changes
230+
that have global shared benefit.
231+
232+
Further Resources
233+
=================
234+
235+
Please see the Implementer Toolkit on the `OpenLMIS website <http://openlmis.org/get-started/implementer-toolkit/>`_ to learn more about best practicies in implementing OpenLMIS. Also, learn more about the `OpenLMIS Community <http://openlmis.org/about/community/>`_ and how to get involved!

0 commit comments

Comments
 (0)