Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 0 additions & 21 deletions docs/contribute/ci/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,19 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

How to Integrate a New Module into the Reference Integration
=============================================================
.. _add_to_ref_integration:

Adding a Module to Reference Integration
========================================

.. document:: Add Module to Reference Integration Guide
:id: doc__add_module_to_ref_integration_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]


This guide explains how to add a new S-CORE module to the
`reference_integration <https://github.com/eclipse-score/reference_integration>`_ repository,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,19 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _building_source_code:
.. _build_module:

Build Module
============

.. document:: Build Module Guide
:id: doc__build_module_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]

Building source code
=====================

SCRAMPLE provides two minimal “Hello World” applications — one in C++ and one in Rust — that
both use the S-CORE ``mw::log`` logging library.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,19 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _cicd_workflows:

CI/CD Workflows
================
===============

.. document:: CI/CD Workflow Guide
:id: doc__ci_cd_workflow_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]


After successfully building the scrample binary, we need to ensure that future changes do not break the build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,19 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

First Eclipse S-CORE Module
=================================
.. _create_new_score_module:

Create New Eclipse S-CORE Module
================================

.. document:: Create New Module Guide
:id: doc__create_new_module_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]


Before starting, ensure you are an official contributor to the Eclipse S-CORE project.
Otherwise, you will not have required permissions. Instructions can be found in
Expand Down Expand Up @@ -90,7 +101,7 @@ Below is an overview of the most relevant files and folders.
.github/workflows/
------------------
Contains CI/CD workflows (build, unit-tests,
:ref:`integration gate <integration_process>` checks).
:ref:`integration gate <integration_introduction>` checks).


.vscode
Expand Down Expand Up @@ -124,7 +135,7 @@ Follows the naming convention ``score/<module_name>/``.
tests/
-------
Component Integration Tests (CIT) and Feature Integration Tests (FIT).
See the :ref:`Technology Overview <technology_overview>` for details on test levels.
See the :ref:`Technology Overview <technology_introduction>` for details on test levels.


.bazelrc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,24 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Documentation generation
==========================

.. _generate_documentation:

Generate Documentation
======================

.. document:: Generate Documentation Guide
:id: doc__generate_documentation_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]


Introduction
---------------
As described in the :ref:`Overview of technologies <technology_overview>` chapter,
As described in the :ref:`Technology Introduction <technology_introduction>` chapter,
Eclipse S-CORE uses the sphinx and sphinx-needs toolchain to generate documentation from rst files.
Elements of Eclipse S-CORE metamodel are represented as sphinx-needs objects.

Expand Down
49 changes: 49 additions & 0 deletions docs/contribute/contribute_new_module/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
..
# *******************************************************************************
# Copyright (c) 2026 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0
#
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _contribution_workflow_guide:

Contribution Work Flow Guide
============================

.. document:: Contribution Work Flow Guide
:id: doc__contribution_work_flow_guide
:status: valid
:version: 1
:safety: QM
:security: NO
:realizes: wp__training_path[version==1]

This guide walks you through contributing a new platform module to Eclipse S-CORE end-to-end.
As a running example you will build a small demo application called
`scrample <https://github.com/eclipse-score/scrample/releases>`_, which shows how
to compose existing S-CORE platform modules into new functionality.

By the end of this section you will have:

- :ref:`Created a properly structured S-CORE module from scratch <create_new_score_module>`.
- :ref:`Generated documentation from source and integrated it into the platform docs <generate_documentation>`.
- :ref:`Build the module with Bazel and verified it compiles cleanly <build_module>`.
- :ref:`Wired up CI/CD workflows so every change is automatically validated <cicd_workflows>`.
- :ref:`Add the module into the reference integration to make it part of the platform <add_to_ref_integration>`.

.. toctree::
:maxdepth: 1
:hidden:
Comment thread
anmittag marked this conversation as resolved.

create_new_score_module.rst
generate_documentation.rst
build_module.rst
cicd_workflows.rst
add_to_ref_integration.rst
Loading
Loading