diff --git a/docs/source/index.rst b/docs/source/index.rst index 1bdf568..afc78f8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -12,46 +12,42 @@ Overview capella2polarion offers several features to interact with Polarion and Capella models. Currently, the following features are available: -Available Features ------------------- - -- **Synchronization of Model-Elements** - - Migrate any model element from a ``capellambse.MelodyModel`` to Polarion as a - work item. Diagrams are taken from a diagram cache (pipeline artifact from a - `capella diagram cache`_) job run to Polarion as work items. The whole folder - with the ``index.json`` and the SVGs is needed for the diagram - synchronization. - - With appropriate :ref:`configuration ` of the service and on - :ref:`Polarion ` any model element can be migrated from a - Capella model to a Polarion project. For an overview of all features related - to the synchronization and supported Capella object types, have a look at the - :ref:`model synchronization ` documentation page. - -- **Rendering of Live-Documents** - - The `render_documents` command in the CLI allows the rendering of Polarion - Live-Documents in a dedicated documents space inside a Polarion project. This - doesn't need to be the sync project. These documents are generated via - rendering Jinja2 templates, enabling them to be enriched by model data - without requiring the data as a work item in Polarion. - - There are two modes for rendering Live-Documents: - - - **Full Authority Documents**: C2P takes full control over the content, and - any human-made changes to the document will be overwritten in the next - rendering cycle. To make changes persistent, modifications to the Jinja2 - templates are required. - - - **Mixed Authority Documents**: C2P takes control over marked sections of - the document, allowing for collaboration where dedicated model-enhanced - areas coexist with human-edited content. - - Detailed information on the Live-Document rendering feature can be found in - the :ref:`render documents ` documentation page. For a - guide on how this service is configured see the :ref:`configuration page - `. +Synchronization of Model-Elements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Migrate any model element from a ``capellambse.MelodyModel`` to Polarion as a +work item. Diagrams are taken from a diagram cache (pipeline artifact from a +`capella diagram cache`_) job run to Polarion as work items. The whole folder +with the ``index.json`` and the SVGs is needed for the diagram synchronization. + +With appropriate :ref:`configuration ` of the service and on +:ref:`Polarion ` any model element can be migrated from a +Capella model to a Polarion project. For an overview of all features related to +the synchronization and supported Capella object types, have a look at the +:ref:`model synchronization ` documentation page. + +Rendering of Live-Documents +^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The `render_documents` command in the CLI allows the rendering of Polarion +Live-Documents in a dedicated documents space inside a Polarion project. This +doesn't need to be the sync project. These documents are generated via +rendering Jinja2 templates, enabling them to be enriched by model data without +requiring the data as a work item in Polarion. + +There are two modes for rendering Live-Documents: + +- **Full Authority Documents**: C2P takes full control over the content, and + any human-made changes to the document will be overwritten in the next + rendering cycle. To make changes persistent, modifications to the Jinja2 + templates are required. + +- **Mixed Authority Documents**: C2P takes control over marked sections of + the document, allowing for collaboration where dedicated model-enhanced + areas coexist with human-edited content. + +Detailed information on the Live-Document rendering feature can be found in the +:ref:`render documents ` documentation page. For a guide on +how this service is configured see the :ref:`configuration page +`. .. note:: Additional features will be documented here in the future as they are developed and integrated.