Skip to content

Commit

Permalink
[CI] Publish Documentation for e3c63fb
Browse files Browse the repository at this point in the history
  • Loading branch information
NPJ-OP-LUX committed Dec 19, 2024
1 parent f925315 commit 85113b5
Show file tree
Hide file tree
Showing 16 changed files with 6,618 additions and 6,628 deletions.
15 changes: 3 additions & 12 deletions epo-wf/Business Process workflow/stage1/stage1.html
Original file line number Diff line number Diff line change
Expand Up @@ -354,16 +354,6 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
<div class="paragraph">
<p>The “Ontology Requirements Specification Document (ORSD)” Business Object as defined in the <a href="https://docs.ted.europa.eu/epo-home/methodology2024.html">ePO LOT methodology</a>, is translated into 2 Data Objects (documents):</p>
</div>
<div class="paragraph">
<p>&lt;&lt;&lt;&lt;&lt;&lt;&lt; HEAD
* The "Print optimised ORSD document, which is stored in the Microsoft sharePoint Server along with the Supplementary ORSD documents.
* The "Web optimised ORSD document", which is stored in the <a href="https://github.com/OP-TED/epo-docs">GitHub OP-TED/epo-docs</a> repository, as an <sup class="footnoteref">[<a class="footnote" href="#_footnotedef_1" title="View footnote.">1</a>]</sup> Asciidoc page. For an example ORSD file in ePO, see <a href="https://github.com/OP-TED/epo-docs/blob/main/modules/ROOT/pages/stories_eAccess.adoc">here</a>.</p>
</div>
<div class="paragraph">
<p>The diagram also describes how the SDS Generation Configuration business object is translated as the “Owl Configuration” Data Object representing the model2owl configuration files that are stored in the <a href="https://github.com/OP-TED/ePO">GitHub OP-TED/epo</a> repository. For an explanation of what these files contain and how to generate them see <a href="https://github.com/OP-TED/ePO/tree/master/implementation/ePO_core/model2owl-config">here</a>. For an example of the configuration files in ePO See <a href="https://github.com/OP-TED/ePO/tree/master/implementation/ePO_core/model2owl-config">here</a>.</p>
</div>
</div>
</div>
<div class="ulist">
<ul>
<li>
Expand All @@ -375,8 +365,7 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
</ul>
</div>
<div class="paragraph">
<p>The diagram also describes how the SDS Generation Configuration business object is translated as the “Owl Configuration” Data Object representing the model2owl configuration files that are stored in the <a href="https://github.com/OP-TED/ePO">OP/ePO</a> repository. For an explanation of what these files contain and how to generate them see <a href="https://github.com/OP-TED/model2owl?tab=readme-ov-file#configuration">here</a>. For an example of the configuration files in ePO See <a href="https://github.com/OP-TED/ePO/tree/master/implementation/ePO_core/model2owl-config">here</a>.
&gt;&gt;&gt;&gt;&gt;&gt;&gt; de79c6bae97441da0ed761ee579c417faeb97376</p>
<p>The diagram also describes how the SDS Generation Configuration business object is translated as the “Owl Configuration” Data Object representing the model2owl configuration files that are stored in the <a href="https://github.com/OP-TED/ePO">OP/ePO</a> repository. For an explanation of what these files contain and how to generate them see <a href="https://github.com/OP-TED/model2owl?tab=readme-ov-file#configuration">here</a>. For an example of the configuration files in ePO See <a href="https://github.com/OP-TED/ePO/tree/master/implementation/ePO_core/model2owl-config">here</a>.</p>
</div>
<div class="imageblock">
<div class="content">
Expand All @@ -388,6 +377,8 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
</div>
</div>
</div>
</div>
</div>
<div id="footnotes">
<hr>
<div class="footnote" id="_footnotedef_1">
Expand Down
4 changes: 2 additions & 2 deletions epo-wf/Business Process workflow/stage2/stage2.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
<p>The first business process of this section is “<strong>Trunk-based development of the Model</strong>”. This is an iterative process that will happen multiple times in this stage. The first time that this process happens, the Development Team will create the first draft of the Conceptual Model as a UML diagram in an Enterprise architect file and store it on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository. During all the subsequent times that this process takes place, the Development team will continue editing and updating the Conceptual Model in order to implement feedback received in the Working Group Meetings. As a result of this business process, the “Conceptual Model (editable)” business object is created or updated. Also In this Process, the Development Team implements any GitHub issues pointed by the Product Owner in the “Decide work goal &amp; scope and release version” business process or any GitHub issues created during the ”CM Working Group Meeting” business process.</p>
</div>
<div class="paragraph">
<p>In the “<strong>Dev Team internal review</strong>” business process, The Development Team uses model2owl on the current Conceptual Model in order to generate a conventions report. See <a href="../stage3/stage3.html#SDSGen" class="xref page">here</a> on how model2owl is used to generate a conventions report. For a conventions report example see <a href="https://github.com/OP-TED/ePO/tree/master/implementation/eAccess/conventions_report">here</a>. The Development Team consults the conventions report and the ORSD, and makes adjustments to the Conceptual Model if needed, going to “Trunk-based development of the Model” or “Fixing Model Bugs in the release version” business process. If no changes are currently needed, the next business process will be “CM Working Group Meeting”.</p>
<p>In the “<strong>Dev Team internal review</strong>” business process, The Development Team uses model2owl on the current Conceptual Model in order to generate a conventions report. See <a href="#../stage3/stage3.adoc#SDSGen" class="xref unresolved">here</a> on how model2owl is used to generate a conventions report. For a conventions report example see <a href="https://github.com/OP-TED/ePO/tree/master/implementation/eAccess/conventions_report">here</a>. The Development Team consults the conventions report and the ORSD, and makes adjustments to the Conceptual Model if needed, going to “Trunk-based development of the Model” or “Fixing Model Bugs in the release version” business process. If no changes are currently needed, the next business process will be “CM Working Group Meeting”.</p>
</div>
<div class="paragraph">
<p>In the ”<strong>CM Working Group Meeting</strong>” business process, that takes place during the weekly Working Group meeting, the Development Team Presents and explains the conceptual model to the rest of the Working Group. The Working Group validates the model and develops it further. By the end of the meeting, the Development Team either:</p>
Expand Down Expand Up @@ -363,7 +363,7 @@ <h2 id="_application_and_technology_view"><a class="anchor" href="#_application_
<p><em>Application and Technology Layers of the “Designing conceptual model” stage diagram</em></p>
</div>
<div class="paragraph">
<p>The “Conceptual Model (editable)” Business Object is translated into the “Enterprise Architect UML Model” Data Object that represents the UML model, which is in turn translated in the “Enterprise Architect Database in .qeax format” artefact located on the ”develop” or “release.X.Y.Z” branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository. The .qeax file can be edited on Enterprise Architect 16 or 17. For simplicity, the owl generated artefacts used by the “Dev Team internal review” process are omitted from this diagram, as they are explained in the <a href="#workflow/Business Process workflow/stage3/stage3.adoc" class="xref unresolved">“Preparing Semantic Data Specification Version Release” Stage</a> in detail.<br></p>
<p>The “Conceptual Model (editable)” Business Object is translated into the “Enterprise Architect UML Model” Data Object that represents the UML model, which is in turn translated in the “Enterprise Architect Database in .qeax format” artefact located on the ”develop” or “release.X.Y.Z” branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository. The .qeax file can be edited on Enterprise Architect 16 or 17. For simplicity, the owl generated artefacts used by the “Dev Team internal review” process are omitted from this diagram, as they are explained in the <a href="#../stage3/stage3.adoc" class="xref unresolved">“Preparing Semantic Data Specification Version Release” Stage</a> in detail.<br></p>
</div>
</div>
</div>
Expand Down
7 changes: 3 additions & 4 deletions epo-wf/Business Process workflow/stage3/stage3.html
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ <h3 id="_sds_generation_substage"><a class="anchor" href="#_sds_generation_subst
<p><em>The SDS Generation substage</em></p>
</div>
<div class="paragraph">
<p>In the “Produce business view of the Conceptual Model” business process, the Development Team exports an HTML page for each folder in the Enterprise Architect (including the folder of the new ePO module) creating the “Conceptual Model visual documentation” business object on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository. This is done automatically by the Enterprise Architect program. These webpages will be reviewed by the Development Team and the Product Owner in their respective business processes later in this stage. In the next stage, “publishing candidate SDS version” the website will be <a href="#../../stage4/stage4.adoc" class="xref unresolved">integrated</a> into <a href="https://github.com/OP-TED/epo-docs">GitHub OP-TED/epo-docs</a> repository and from there published in the TED developer documentation website.</p>
<p>In the “Produce business view of the Conceptual Model” business process, the Development Team exports an HTML page for each folder in the Enterprise Architect (including the folder of the new ePO module) creating the “Conceptual Model visual documentation” business object on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository. This is done automatically by the Enterprise Architect program. These webpages will be reviewed by the Development Team and the Product Owner in their respective business processes later in this stage. In the next stage, “publishing candidate SDS version” the website will be <a href="#../stage4/stage4.adoc" class="xref unresolved">integrated</a> into <a href="https://github.com/OP-TED/epo-docs">GitHub OP-TED/epo-docs</a> repository and from there published in the TED developer documentation website.</p>
</div>
<div class="imageblock">
<div class="content">
Expand All @@ -336,8 +336,7 @@ <h3 id="_sds_generation_substage"><a class="anchor" href="#_sds_generation_subst
<p><em>Publish HTML versions in EA</em></p>
</div>
<div class="paragraph">
<p>These webpages will be reviewed by the Development Team and the Product Owner in their respective business processes later in this stage. In the next stage, “publishing candidate SDS version” the website will be integrated into <a href="https://github.com/OP-TED/epo-docs">OP/ePO-docs</a> repository and from there published in the TED developer documentation website.
&gt;&gt;&gt;&gt;&gt;&gt;&gt; de79c6bae97441da0ed761ee579c417faeb97376</p>
<p>These webpages will be reviewed by the Development Team and the Product Owner in their respective business processes later in this stage. In the next stage, “publishing candidate SDS version” the website will be integrated into <a href="https://github.com/OP-TED/epo-docs">OP/ePO-docs</a> repository and from there published in the TED developer documentation website.</p>
</div>
<div class="paragraph">
<p>In the “Produce the interchange format of the conceptual model” business process, the Development Team exports an .XMI file containing all the UML concepts including classes, attributes, properties, notes, etc., found in the diagrams of the Conceptual Model (editable) business object. The XMI file shall be used as an input for model2owl toolkit in order to generate the SDS artefacts. Currently the version of the XMI/UML that is being exported is 2.5.1. The XMI file is placed into the model2owl input folder on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository and is represented as the “Conceptual Model (exchangeable)” business Object on the workflow diagram.</p>
Expand Down Expand Up @@ -365,7 +364,7 @@ <h3 id="_sds_generation_substage"><a class="anchor" href="#_sds_generation_subst
<p>In the “Generate human-readable artefacts” Business Process, the Development Team triggers a GitHub action that prompts model2owl toolkit to automatically generate the “SDS reference document” Business Object (the glossaries), and possibly other human-readable reference documentation artefacts on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository.</p>
</div>
<div class="paragraph">
<p>In the “Generate diffing artefacts” Business Process, the Development Team triggers a GitHub action that prompts model2owl toolkit to automatically generate diffing reports, and change notes by comparing the current version XMI, with the latest published version of SDS. For dealing with deprecation, refer to <a href="#../../stage2.adoc" class="xref unresolved">../../stage2.adoc</a> for more information. Specifically, the following Business Objects are generated on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository as described in the <a href="#../../SDS and related artefacts\SDSmodel2owl.adoc#Purpose 4" class="xref unresolved">SES Model2owl document</a>:</p>
<p>In the “Generate diffing artefacts” Business Process, the Development Team triggers a GitHub action that prompts model2owl toolkit to automatically generate diffing reports, and change notes by comparing the current version XMI, with the latest published version of SDS. For dealing with deprecation, refer to <a href="#../stage2.adoc" class="xref unresolved">../stage2.adoc</a> for more information. Specifically, the following Business Objects are generated on the develop branch of the <a href="https://github.com/OP-TED/epo-conceptual-model">GitHub OP-TED/epo-conceptual-model</a> repository as described in the <a href="../../SDS%20and%20related%20artefacts/SDSmodel2owl.html#Purpose 4" class="xref page">SDS Model2owl document</a>:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
Expand Down
2 changes: 1 addition & 1 deletion epo-wf/Business Process workflow/stage5/stage5.html
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
<h2 id="_application_and_technology_view"><a class="anchor" href="#_application_and_technology_view"></a>Application and Technology view</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The concise diagram for the Publishing Stable SDS Version” Stage that describes all the artefacts involved in this stage using business (yellow), application (blue) and technology (green) layers is depicted in the figure below. The GitHub Repository branch that is used for this stage is also depicted as an orange rectangle for reference purposes. The only Business artefact that is modified in this stage is the “SDS documentation” as the “rc” mark is removed from all the documents containing it. In order for this change to be displayed online, the “eProcurement Ontology staging website” and “eProcurement Ontology website” data objects must be regenerated by following the same process as the one described in <a href="#workflow/Business Process workflow/stage4/stage4.adoc" class="xref unresolved">stage 4</a>.</p>
<p>The concise diagram for the Publishing Stable SDS Version” Stage that describes all the artefacts involved in this stage using business (yellow), application (blue) and technology (green) layers is depicted in the figure below. The GitHub Repository branch that is used for this stage is also depicted as an orange rectangle for reference purposes. The only Business artefact that is modified in this stage is the “SDS documentation” as the “rc” mark is removed from all the documents containing it. In order for this change to be displayed online, the “eProcurement Ontology staging website” and “eProcurement Ontology website” data objects must be regenerated by following the same process as the one described in <a href="#../stage4/stage4.adoc" class="xref unresolved">stage 4</a>.</p>
</div>
<div class="imageblock">
<div class="content">
Expand Down
Loading

0 comments on commit 85113b5

Please sign in to comment.