Skip to content

Commit

Permalink
[RELEASE] 1.0.0.RELEASE (ci_docker,ci_documentation)
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexGuironnetRTE committed Mar 9, 2020
1 parent 15507b2 commit 2c3b410
Show file tree
Hide file tree
Showing 34 changed files with 70 additions and 70 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

= Contributing
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: macro
Expand Down
2 changes: 1 addition & 1 deletion README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ don't quite cover what you're planning to do, please look into the <<Recipes>>
section.

TIP: In addition, a
link:https://opfab.github.io/documentation/1.0.0.SNAPSHOT/start/[Getting
link:https://opfab.github.io/documentation/1.0.0.RELEASE/start/[Getting
Started guide on our website] exists.
Check it out !

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.0.SNAPSHOT
1.0.0.RELEASE
4 changes: 2 additions & 2 deletions client/actions/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Thirds Data Model Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions client/cards/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Card Data Model Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions client/thirds/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Thirds Data Model Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions client/time/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Time Data Model Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions client/users/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Users Data Model Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions services/core/actions/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Actions Service Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
2 changes: 1 addition & 1 deletion services/core/actions/src/main/modeling/swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
description: OperatorFabric ThirdParty Management API
version: 1.0.0.SNAPSHOT
version: 1.0.0.RELEASE
title: Action handling
termsOfService: ''
contact:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ of the card.
=== Archive endpoints in the card-consultation API

This Archives screen relies on dedicated endpoints in the card-consultation API, as described
link:https://opfab.github.io/projects/services/core/cards-consultation/1.0.0.SNAPSHOT/api/#Archives[here].
link:https://opfab.github.io/projects/services/core/cards-consultation/1.0.0.RELEASE/api/#Archives[here].
4 changes: 2 additions & 2 deletions services/core/cards-consultation/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Card Consultation Service Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This card contains some data but when selected in the feed nothing more than the

==== Fully useful

When a card is selected in the feed (of the GUI), the data is displayed in the detail panel. The way details are formatted depends on template uploaded by Third parties as link:https://opfab.github.io/projects/services/core/thirds/1.0.0.SNAPSHOT/reference/#_bundle[describe here]. To have an effective example without to many actions to performed, the following example will use an already existing configuration.The one presents in the development version of OperatorFabric, for test purpose(`TEST` bundle).
When a card is selected in the feed (of the GUI), the data is displayed in the detail panel. The way details are formatted depends on template uploaded by Third parties as link:https://opfab.github.io/projects/services/core/thirds/1.0.0.RELEASE/reference/#_bundle[describe here]. To have an effective example without to many actions to performed, the following example will use an already existing configuration.The one presents in the development version of OperatorFabric, for test purpose(`TEST` bundle).

At the card level, the attributes in the card telling OperatorFabric which template to use is the `details` attributes.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Some cards can emit a sound when displayed in the feed of the GUI, the id of aud

This attribute is a string of objects containing a `title` attribute which is `i18n` key and a `template` attribute which refers to a template name contained in the publisher bundle. The bundle in which those resources will be looked for is the one corresponding of the <<_card_publisher_version, version>> declared in the card for the current <<_card_publisher, publisher>>. If no resource is found, either because there is no bundle for the given version or there is no resource for the given key, then the corresponding key is displayed in the details section of the GUI.

link:../../../thirds/1.0.0.SNAPSHOT/reference/#_bundle[See the documentation about third bundle in the Third service documentation].
link:../../../thirds/1.0.0.RELEASE/reference/#_bundle[See the documentation about third bundle in the Third service documentation].

*example:*

Expand Down
6 changes: 3 additions & 3 deletions services/core/cards-publication/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= OperatorFabric Card Publication Service
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand All @@ -29,7 +29,7 @@ For a card stored in a file named `card.json`, with an OperatorFabric running on
curl -X POST http://localhost:2102/cards -H "Content-Type:application/type" --data @card.json
....

For more details about possibilities about the Card Publication REST API please refer to the <<_publication_rest_api_overview>> chapter or to the link:https://opfab.github.io/projects/services/core/cards-publication/1.0.0.SNAPSHOT/api/[swagger documentation].
For more details about possibilities about the Card Publication REST API please refer to the <<_publication_rest_api_overview>> chapter or to the link:https://opfab.github.io/projects/services/core/cards-publication/1.0.0.RELEASE/api/[swagger documentation].

include::01_Card_Examples.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
description: OperatorFabric Card Consumer Service
version: 1.0.0.SNAPSHOT
version: 1.0.0.RELEASE
title: Card Management API
termsOfService: ''
contact:
Expand Down
6 changes: 3 additions & 3 deletions services/core/thirds/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ see link:../../../[OperatorFabric main page]

== Features

see https://opfab.github.io/projects/services/core/thirds/1.0.0.SNAPSHOT/reference/#_techincal_overview[reference documentation : Technical overview ]
see https://opfab.github.io/projects/services/core/thirds/1.0.0.RELEASE/reference/#_techincal_overview[reference documentation : Technical overview ]

=== Third Party bundle

Expand Down Expand Up @@ -85,8 +85,8 @@ bundle
}
----

See https://opfab.github.io/projects/services/core/thirds/1.0.0.SNAPSHOT/api/#__Models[swagger generated documentation model section] for data description
See https://opfab.github.io/projects/services/core/thirds/1.0.0.RELEASE/api/#__Models[swagger generated documentation model section] for data description

== 3. Rest Endpoints and Data Model

See https://opfab.github.io/projects/services/core/thirds/1.0.0.SNAPSHOT/api[swagger generated documentation]
See https://opfab.github.io/projects/services/core/thirds/1.0.0.RELEASE/api[swagger generated documentation]
4 changes: 2 additions & 2 deletions services/core/thirds/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= OperatorFabric Third service
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
2 changes: 1 addition & 1 deletion services/core/thirds/src/main/modeling/swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
description: OperatorFabric ThirdParty Management API
version: 1.0.0.SNAPSHOT
version: 1.0.0.RELEASE
title: Thirds Management
termsOfService: ''
contact:
Expand Down
2 changes: 1 addition & 1 deletion services/core/time/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ is the sole responsibility of the third party services

== Rest Endpoints and Data Model

See https://opfab.github.io/projects/services/core/time/1.0.0.SNAPSHOT/api/index.html[swagger generated documentation]
See https://opfab.github.io/projects/services/core/time/1.0.0.RELEASE/api/index.html[swagger generated documentation]

== Disclaimer

Expand Down
4 changes: 2 additions & 2 deletions services/core/time/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Time Service Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
2 changes: 1 addition & 1 deletion services/core/time/src/main/modeling/swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
description: OperatorFabric Time Management API
version: 1.0.0.SNAPSHOT
version: 1.0.0.RELEASE
title: Time Management
termsOfService: ''
contact:
Expand Down
14 changes: 7 additions & 7 deletions services/core/users/src/docs/asciidoc/00_cookbook.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

A new operator call John Doe, who has OAuth granted right to connect ot current `OperatorFabric` instance, need to receive cards within current `OperatorFabric` instance. As a user of OperatorFabric, he needs to be added to the system with a `login` (john-doe-operator), his `firstName` (John) and his `lastName` (Doe).
operator
As there is no `Administration GUI` for the moment, it must be performed through command line, as specify link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#SimpleUser[here].
As there is no `Administration GUI` for the moment, it must be performed through command line, as specify link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#SimpleUser[here].

=== List all users

Expand Down Expand Up @@ -135,7 +135,7 @@ HTTP/1.1 200 OK

=== Update user details

As shown by this result, the firstName of the new operator has been misspelled.We need link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#updateUser[to update the existing user] with `john-doe-operator` login. To correct this mistake, the following commands can be used :
As shown by this result, the firstName of the new operator has been misspelled.We need link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#updateUser[to update the existing user] with `john-doe-operator` login. To correct this mistake, the following commands can be used :

with httpie:
....
Expand All @@ -160,7 +160,7 @@ HTTP/1.1 200 OK

=== List groups

This operator is the first member of a new group operator called the `OPERATORS`, which doesn't exist for the moment in the system. As shown when we link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#fetchGroups[lists the groups existing in the server].
This operator is the first member of a new group operator called the `OPERATORS`, which doesn't exist for the moment in the system. As shown when we link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#fetchGroups[lists the groups existing in the server].

Httpie
....
Expand Down Expand Up @@ -210,7 +210,7 @@ HTTP/1.1 200 OK

=== Create a new Group

Firstly, the group called `OPERATORS` has link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#createGroup[to be added to the system] using the following command:
Firstly, the group called `OPERATORS` has link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#createGroup[to be added to the system] using the following command:

using httpie:
....
Expand All @@ -234,7 +234,7 @@ HTTP/1.1 200 OK

=== Fetch details of a given group

The result return seems strange, to verify if it's the correct answer by link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#fetchGroup[displaying the details of the group] called `OPERATORS`, use the following command:
The result return seems strange, to verify if it's the correct answer by link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#fetchGroup[displaying the details of the group] called `OPERATORS`, use the following command:

using httpie:
....
Expand All @@ -258,7 +258,7 @@ HTTP/1.1 200 OK

=== Update details of a group

The description is really null. After verification, in our first command used to create the group, the attribute for the description is misspelled. Using the following command link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#updateGroup[to update the group], with the correct spelling, the new group of operator gets a proper description:
The description is really null. After verification, in our first command used to create the group, the attribute for the description is misspelled. Using the following command link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#updateGroup[to update the group], with the correct spelling, the new group of operator gets a proper description:

with httpie:
....
Expand All @@ -280,7 +280,7 @@ response

=== Add a user to a group

As both new group and new user are correct it's time link:https://opfab.github.io/projects/services/core/users/1.0.0.SNAPSHOT/api/#addGroupUsers[to make the user member of the group]. To achieve this, use the following command:
As both new group and new user are correct it's time link:https://opfab.github.io/projects/services/core/users/1.0.0.RELEASE/api/#addGroupUsers[to make the user member of the group]. To achieve this, use the following command:

with httpie:
....
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The administration of the groups is dealt by the administrator manually. More de

=== Groups

The notion of group is loose and can be used to simulate role in `OperatorFabric`. Groups are used to send cards to several users without name them specifically. The information about membership to a group is stored in the user information. The rules used to send cards are describe in the link:https://opfab.github.io/projects/services/core/cards-publication/1.0.0.SNAPSHOT/reference/#_card_recipients[Card Publication Service].
The notion of group is loose and can be used to simulate role in `OperatorFabric`. Groups are used to send cards to several users without name them specifically. The information about membership to a group is stored in the user information. The rules used to send cards are describe in the link:https://opfab.github.io/projects/services/core/cards-publication/1.0.0.RELEASE/reference/#_card_recipients[Card Publication Service].

==== Alternative way to manage groups

Expand Down
4 changes: 2 additions & 2 deletions services/core/users/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= OperatorFabric User Service
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
2 changes: 1 addition & 1 deletion services/core/users/src/main/modeling/swagger.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
swagger: '2.0'
info:
description: OperatorFabric User Management API
version: 1.0.0.SNAPSHOT
version: 1.0.0.RELEASE
title: User Management
termsOfService: ''
contact:
Expand Down
4 changes: 2 additions & 2 deletions services/infra/client-gateway/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= Client Gateway Service Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions services/web/web-ui/src/docs/asciidoc/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= OperatorFabric Web UI Reference Documentation
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/architecture/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@


:revnumber:
:revdate: 10 February 2020
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
4 changes: 2 additions & 2 deletions src/docs/asciidoc/developer_guide/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


= OperatorFabric Developer Guide
:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down
6 changes: 3 additions & 3 deletions src/docs/asciidoc/start/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@



:revnumber: 1.0.0.SNAPSHOT
:revdate: 10 February 2020
:revnumber: 1.0.0.RELEASE
:revdate: 09 March 2020
:imagesdir: images
:sectnums:
:toc: left
Expand Down Expand Up @@ -87,7 +87,7 @@ image::formated-card-details.jpg[detail card screenshot]
==== Anatomy of the card :
A card is containing information regarding the publisher, the recipients , the process , the data to show ...

More information can be found on the user guide : https://opfab.github.io/documentation/1.0.0.SNAPSHOT/user_guide/#_card_anatomy
More information can be found on the user guide : https://opfab.github.io/documentation/1.0.0.RELEASE/user_guide/#_card_anatomy

----
{
Expand Down
2 changes: 1 addition & 1 deletion src/docs/asciidoc/user_guide/02_configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
:spring_cloud_gateway_doc: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.1.0.RELEASE/
:mongo_doc: https://docs.mongodb.com/manual/reference/
:spring_amqp_doc: https://docs.spring.io/spring-amqp/docs/2.1.3.RELEASE/reference/htmlsingle/
:opfab_architecture_doc: https://opfab.github.io/documentation/1.0.0.SNAPSHOT/architecture/
:opfab_architecture_doc: https://opfab.github.io/documentation/1.0.0.RELEASE/architecture/

== Configuration

Expand Down
Loading

0 comments on commit 2c3b410

Please sign in to comment.