Skip to content

Commit

Permalink
[CI] Publish Documentation for 0e0516a
Browse files Browse the repository at this point in the history
  • Loading branch information
NPJ-OP-LUX committed Dec 16, 2024
1 parent 3e08503 commit 29a0b7c
Show file tree
Hide file tree
Showing 30 changed files with 6,685 additions and 6,734 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -338,7 +341,7 @@ <h2 id="_the_requirements_gathering_stage"><a class="anchor" href="#_the_require
<h2 id="_the_designing_conceptual_model_stage"><a class="anchor" href="#_the_designing_conceptual_model_stage"></a><a href="stage2/stage2.html" class="xref page">The Designing Conceptual Model stage</a></h2>
<div class="sectionbody">
<div class="paragraph">
<p>In this stage, the Development Team works with the rest of the Working Group in order to design the Conceptual Model (CM) of the module to be released. The CM is represented as a collection of UML diagrams in an <a href="https://sparxsystems.com/">Enterprise Architect</a> file at the Github CM repository.</p>
<p>In this stage, the Development Team works with the rest of the Working Group in order to design the Conceptual Model (CM) of the module to be released. The CM is represented as a collection of UML diagrams in a Sparx EnterpriseArchitecture file at the Github CM repository.</p>
</div>
</div>
</div>
Expand Down
40 changes: 3 additions & 37 deletions epo-wf/Business Process workflow/businessProcessWorkflowIndex.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -307,8 +310,6 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</aside>
<article class="doc">
<h1 class="page">Business Process workflow</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This section describes all the stages of an ePO release life cycle as a business process workflow. This workflow includes all the artefacts related to the creation of an ePO release and how they change during each stage of the workflow. This workflow does not include maintenance work that happens simultaneously with the development of the new ePO release such as alignment with other procurement data models, or alignment with the ESPD or eForms standards.</p>
</div>
Expand Down Expand Up @@ -350,41 +351,6 @@ <h1 class="page">Business Process workflow</h1>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_pages_in_this_section"><a class="anchor" href="#_pages_in_this_section"></a>Pages in this section</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_stakeholders"><a class="anchor" href="#_stakeholders"></a><a href="stakeholders.html" class="xref page">Stakeholders</a></h3>

</div>
<div class="sect2">
<h3 id="_business_process_overview"><a class="anchor" href="#_business_process_overview"></a><a href="businessProcessOverview.html" class="xref page">Business process overview</a></h3>

</div>
<div class="sect2">
<h3 id="_stage_1_requirements_gathering"><a class="anchor" href="#_stage_1_requirements_gathering"></a><a href="stage1/stage1.html" class="xref page">Stage 1: Requirements Gathering</a></h3>

</div>
<div class="sect2">
<h3 id="_stage_2_designing_conceptual_model"><a class="anchor" href="#_stage_2_designing_conceptual_model"></a><a href="stage2/stage2.html" class="xref page">Stage 2: Designing Conceptual Model</a></h3>

</div>
<div class="sect2">
<h3 id="_stage_3_preparing_semantic_data_specification_version_release"><a class="anchor" href="#_stage_3_preparing_semantic_data_specification_version_release"></a><a href="stage3/stage3.html" class="xref page">Stage 3: Preparing Semantic Data Specification Version Release</a></h3>

</div>
<div class="sect2">
<h3 id="_stage_4_publishing_candidate_semantic_data_specification_version"><a class="anchor" href="#_stage_4_publishing_candidate_semantic_data_specification_version"></a><a href="stage4/stage4.html" class="xref page">Stage 4: Publishing Candidate Semantic Data Specification Version</a></h3>

</div>
<div class="sect2">
<h3 id="_stage_5_publishing_stable_sds_version"><a class="anchor" href="#_stage_5_publishing_stable_sds_version"></a><a href="stage5/stage5.html" class="xref page">Stage 5: Publishing Stable SDS Version</a></h3>

</div>
</div>
</div>
</article>
<div id="widgetContainer">
<article class="widget">
Expand Down
13 changes: 8 additions & 5 deletions epo-wf/Business Process workflow/stage1/stage1.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -311,7 +314,7 @@ <h1 class="page">Stage 1: Requirements Gathering</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>In this stage, all preliminary work is done such as deciding the ePO version that will be released, what contents are foreseen for this release and the creation of the necessary GitHub branches. Also in this stage, the requirements for the new ePO module are collected in the Ontology Requirements Specification Document (ORSD) by the Working Group.</p>
<p>In this stage, all preliminary work is done such as deciding the ePO version that will be released, what contents are foreseen for this release and the creation of the necessary GitHub branches. Also in this stage, the requirements for the new ePO module are collected in the Ontology Requirements Specification Document (ORSD) by the Working Group. If no new module is required for this release then the ORSD shall contain specifications for each of the updates required for the existing modules.</p>
</div>
</div>
</div>
Expand Down Expand Up @@ -341,7 +344,7 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
<p><em>Requirements Gathering business view with stakeholders diagram</em></p>
</div>
<div class="paragraph">
<p>In the “Decide work goal &amp; scope and release version” business process, The Product Owner decides which ePO module will be developed and into which version the module will be released. The versioning follows a “X.Y.Z” format, where X is the major version number, Y the minor version number, and Z the patch version number. For more information on ePO versioning rules, consult <a href="https://docs.ted.europa.eu/epo-home/versioning.html">this page</a>. Finally, in this business process, the Product Owner points out to the Development Team the GitHub Issues that will be implemented in the upcoming version. These GitHub Issues are assigned the milestone related to the X.Y.Z release.</p>
<p>In the “Decide work goal &amp; scope and release version” business process, The Product Owner decides which ePO module will be developed, if any, and into which version the module will be released. The versioning follows a “X.Y.Z” format, where X is the major version number, Y the minor version number, and Z the patch version number. For more information on ePO versioning rules, consult <a href="https://docs.ted.europa.eu/epo-home/versioning.html">this page</a>. Finally, in this business process, the Product Owner points out to the Development Team the GitHub Issues that will be implemented in the upcoming version. These GitHub Issues are assigned the milestone related to the X.Y.Z release.</p>
</div>
<div class="paragraph">
<p>In the "<strong>Prepare the publication space for the work</strong>" business process, The Product Owner creates the GitHub release branches marked as “release/X.Y.Z” of the specific ePO version in the following GitHub repositories (as they appear in the figure above: <br>
Expand All @@ -350,13 +353,13 @@ <h2 id="_business_view"><a class="anchor" href="#_business_view"></a>Business vi
- The <a href="https://github.com/OP-TED/epo-docs">OP/ePO-docs</a> where the contents of the website containing the SDS documentation will be moved and/or generated.</p>
</div>
<div class="paragraph">
<p>In the “<strong>Configure the artefact transformation pipeline</strong>“ business process, the Development Team Configures the model2owl transformation script on the release/X.Y.Z branch of the OP/epo-conceptual-model repository in order for model2owl to correctly transform the conceptual model of the new module. The development may need to make additional adjustments to the configuration files during the “preparing SDS version release” stage if needed. As a result of this business process, the SDS Generation Configuration business object is created.</p>
<p>In the “<strong>Configure the artefact transformation pipeline</strong>“ business process, the Development Team Configures the model2owl transformation script on the release/X.Y.Z branch of the OP/epo-conceptual-model repository in order for model2owl to correctly transform the conceptual model of the new release. The development may need to make additional adjustments to the configuration files during the “preparing SDS version release” stage if needed. As a result of this business process, the SDS Generation Configuration business object is created.</p>
</div>
<div class="paragraph">
<p>In the "<strong>Collect subject relevant material</strong>" business process, the ePO Working Group starts to meet on a weekly basis in order to develop the new ePO module. In the first meetings the Working Group collects and analyses relevant material to the new ePO module such as reports, sample data, and PEPPOL specifications. All the resulting files from this process are stored on a drive in Sharepoint. As a result of this business process, the “ORSD Supplementary Material” business object is created.</p>
<p>In the "<strong>Collect subject relevant material</strong>" business process, the ePO Working Group starts to meet on a weekly basis in order to develop the new ePO release. In the first meetings the Working Group collects and analyses relevant material to the new ePO release such as reports, sample data, and PEPPOL specifications. All the resulting files from this process are stored on a drive in Sharepoint. As a result of this business process, the “ORSD Supplementary Material” business object is created.</p>
</div>
<div class="paragraph">
<p>In the "<strong>Interview domain experts</strong>" business process, the Working Group discusses the nature of the module. Specifically, the domain experts that are part of the Working Group describe the eProcurement process that needs to be modeled in detail and are interviewed by the Development Team in order to fill any missing information regarding the eProcurement process. During these sessions, domain experts may provide or point out additional ORSD supplementary material to the rest of the Working Group.</p>
<p>In the "<strong>Interview domain experts</strong>" business process, the Working Group discusses the nature of the release. Specifically, the domain experts that are part of the Working Group describe the eProcurement processes that need to be modeled in detail and are interviewed by the Development Team in order to fill any missing information regarding the eProcurement process. During these sessions, domain experts may provide or point out additional ORSD supplementary material to the rest of the Working Group.</p>
</div>
<div class="paragraph">
<p>In the "<strong>Writing ORSD</strong>" business process, the Development Team writes the ORSD as Word document in OP Sharepoint using the ORSD Supplementary Material, and the notes from the interviews with domain experts. The Ontology Requirements Specification Document (ORSD) Business Object is created as a result of this business process.</p>
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/Business Process workflow/stage2/stage2.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/Business Process workflow/stage3/stage3.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/Business Process workflow/stage4/stage4.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/Business Process workflow/stage5/stage5.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
5 changes: 4 additions & 1 deletion epo-wf/Business Process workflow/stakeholders.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -329,7 +332,7 @@ <h1 class="page">Stakeholders</h1>
<p><strong>The Working Group (WG)</strong> includes the Product Owner, the Development team, and other entities such as domain experts. The Working Group is the primary information provider for the creation of the new release and actively takes part in the development of the Ontology Requirements Specification Document (ORSD) and the designing of the Conceptual Model that implements the specifications listed in the ORSD. The Working Group’s main responsibility is to make sure that the new ePO module captures all the aspects of the specified domain correctly, and as concise as possible. Other responsibilities include maintenance tasks such as discussing ePO GitHub issues that may or may not be relevant to the new ePO module and adding or modifying definitions to existing ePO concepts. The Working Group meets twice per week. The first meeting is dedicated to the new module development and the second to maintenance tasks. Meeting Minutes of the Working Group meetings are kept by the Development Team. These Meeting Minutes are then Reviewed by the Product Owner and are subsequently uploaded to the Documentation Site by the Development Team.</p>
</div>
<div class="paragraph">
<p><strong>The Wider Public</strong> includes any member in the Procurement and Semantic Web Communities that may be interested in ePO. The Wider Public is invited by the Product Owner to review a release candidate in a two-month period. During that time The Product Owner and the Development team receive questions, clarifications and feedback for the new release Candidate.</p>
<p><strong>The Wider Public</strong> includes any member in the Procurement and Semantic Web Communities that may be interested in ePO. The Wider Public is invited by the Product Owner to review a release candidate in a two-month period. During that time The Product Owner and the Development team receive questions, clarifications and feedback for the new release Candidate. The Wider Public is also invited to at least two wider working group meetings per year in order to be informed of the latest updates to the Ontology.</p>
</div>
</article>
<div id="widgetContainer">
Expand Down
5 changes: 4 additions & 1 deletion epo-wf/GitHub repositories/githubRepositories.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item is-current-page" data-depth="1">
<a class="nav-link" href="githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -297,7 +300,7 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
<nav class="breadcrumbs" aria-label="breadcrumbs">
<ul>
<li><a href="../index.html">eProcurement Ontology</a></li>
<li><a href="githubRepositories.html">GitHub repositories</a></li>
<li><a href="githubRepositories.html">GitHub Repositories</a></li>
</ul>
</nav>
</div>
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/SDS and related artefacts/SDSArtefacts.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
19 changes: 3 additions & 16 deletions epo-wf/SDS and related artefacts/SDSIndex.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -307,25 +310,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</aside>
<article class="doc">
<h1 class="page">SDS and related artefacts</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This section defines the artefacts generated throughout the ePO lifecycle, detailing their groups, purposes, and requirements. It includes an introduction to model2owl, the tool used for automating artefact generation and validation.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_sds_artefact_groups_and_purposes"><a class="anchor" href="#_sds_artefact_groups_and_purposes"></a><a href="SDSArtefacts.html" class="xref page">SDS artefact groups and purposes</a></h2>
<div class="sectionbody">

</div>
</div>
<div class="sect1">
<h2 id="_model2owl_in_a_nutshell_and_its_functionalities"><a class="anchor" href="#_model2owl_in_a_nutshell_and_its_functionalities"></a><a href="model2owl.html" class="xref page">model2owl in a nutshell (and its functionalities)</a></h2>
<div class="sectionbody">

</div>
</div>
</article>
<div id="widgetContainer">
<article class="widget">
Expand Down
3 changes: 3 additions & 0 deletions epo-wf/SDS and related artefacts/model2owl.html
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ <h3 class="title"><a href="../index.html">eProcurement Ontology</a></h3>
</li>
</ul>
</li>
<li class="nav-item" data-depth="1">
<a class="nav-link" href="../GitHub%20repositories/githubRepositories.html">GitHub Repositories</a>
</li>
</ul>
</li>
</ul>
Expand Down
Loading

0 comments on commit 29a0b7c

Please sign in to comment.