Skip to content

docs: update landing page to recent status #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

docs: update landing page to recent status #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b6fc726
docs: update naming to s-core
pahmann Mar 14, 2025
f4a8529
docs: update links from landing page to score
pahmann Mar 14, 2025
b93ff19
docs: correct meeting information to latest status
pahmann Mar 14, 2025
60fb7dd
docs: correct typos
pahmann Mar 14, 2025
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
6 changes: 3 additions & 3 deletions docs/_assets/css/score.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ html {
text-decoration: underline;
}

/* SCORE specfic colors
/* S-CORE specfic colors
A list of available colro variable names for pyData Sphinx Theme can be found at
https://pydata-sphinx-theme.readthedocs.io/en/stable/_downloads/565fbb3ecf2b3048f5fb3953890ba176/_color.scss

Expand Down Expand Up @@ -75,7 +75,7 @@ ul.navbar-nav li a {
.toc-entry a.nav-link {
color: var(--pst-color-text-base);
}
/* Left, top SCORE brand */
/* Left, top S-CORE brand */
.navbar-brand p
{
color: var(--pst-color-text-muted);
Expand Down Expand Up @@ -118,7 +118,7 @@ blockquote {
background-color: rgba(0,0,0,0.1);
}

/* SCORE Background video
/* S-CORE Background video
Source: https://www.imi21.com/background-video-full-screen.php */

div.score_banner {
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "SCORE"
project = "S-CORE"
copyright = "2024, Score"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright is not updated

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right. I basically had a find and replace for SCORE as match case. On your point with S-CORE vs score. I would stick to score in any form of pathes, tooling and so on. I observed on the other hand that we already have a mixture of S-CORE and SCORE within the score repo. I created an issue #663 in score for exactly that thing.

author = "SCORE committers"
author = "S-CORE committers"
release = "0.1"

# -- General configuration ---------------------------------------------------
Expand Down
52 changes: 26 additions & 26 deletions docs/get_involved.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,59 +20,59 @@
Get involved
============

How to get in contact with SCORE
--------------------------------
How to get in contact with S-CORE
---------------------------------

If you want to get into contact with SCORE, these are your primary entry points:
If you want to get into contact with S-CORE, these are your primary entry points:

:Project Mailing List: [email protected]

:Architectural Discussion: `#score-project-channel-public <https://sdvworkinggroup.slack.com/archives/C083Z4VL90B>`__

| **General Information / Alignment regarding SCORE as a basis for distributions & products:**
| Contact one of the project leads of SCORE https://projects.eclipse.org/projects/automotive.score/who
| **General Information / Alignment regarding S-CORE as a basis for distributions & products:**
| Contact one of the project leads of S-CORE https://projects.eclipse.org/projects/automotive.score/who

The technical HOWTO regarding involvement into SCORE is described here:
The technical HOWTO regarding involvement into S-CORE is described here:
https://github.com/eclipse-score/score/blob/main/CONTRIBUTION.md

How to get involved into SCORE
------------------------------
How to get involved into S-CORE
-------------------------------

The :underline:`only` way to influence SCORE is TO CONTRIBUTE. Everybody can contribute – SCORE is open.
The :underline:`only` way to influence S-CORE is TO CONTRIBUTE. Everybody can contribute – S-CORE is open.

Active Contributions to the SCORE project are the basis for getting involved. The SCORE Project works according to
Active Contributions to the S-CORE project are the basis for getting involved. The S-CORE Project works according to
the Eclipse Project Handbook and has named and elected project leads and committers (see https://projects.eclipse.org/projects/automotive.score/who).
Direction of the SCORE project is discussed and decided in the project lead circle, technical direction is created and prediscussed in the tech
lead circle. Meeting notes are transparent via the SCORE github organization. (see https://github.com/orgs/eclipse-score/discussions)
Direction of the S-CORE project is discussed and decided in the project lead circle, technical direction is created and discussed upfront in the tech
lead circle. Meeting notes are transparent via the S-CORE github organization. (see https://github.com/orgs/eclipse-score/discussions)

We aim to build a safety ready full stack architecture, where components fit to each other in
automotive grade Software Quality and performance. To achieve this, we follow a strict
`feature roadmap and architecture <https://eclipse-score.github.io/score/score_releases/index.html#releases>`_
and a `rigid software development process <https://eclipse-score.github.io/score/process/index.html#process-description>`_
`feature roadmap and architecture <https://eclipse-score.github.io/score/main/score_releases/index.html>`_
and a `rigid software development process <https://eclipse-score.github.io/score/main/process/index.html>`_
(currently under development).

Contributions to the SCORE project must therefore follow the technical direction of the project and the SCORE
architecture. All work in SCORE will therefore follow a
`Contribution Request Guideline <https://eclipse-score.github.io/score/process/guidance/contribution_request/index.html>`_.
Features on the roadmap of SCORE are defined, Contribution Requests create the basis for individual contributions from
within the SCORE project and also from the outside.
Contributions to the S-CORE project must therefore follow the technical direction of the project and the S-CORE
architecture. All work in S-CORE will therefore follow a
`Contribution Request Guideline <https://eclipse-score.github.io/score/main/contribute/contribution_request/contribution_request.html>`_.
Features on the roadmap of S-CORE are defined, Contribution Requests create the basis for individual contributions from
within the S-CORE project and also from the outside.

You can make proposals for new features or architectural building blocks besides the active contribution requests.
Those will not by default be part of the next release of SCORE, because the SCORE release roadmap will strictly
Those will not by default be part of the next release of S-CORE, because the S-CORE release roadmap will strictly
comply with the contribution request structure.
We plan to have the initial contribution request structure available in the SCORE GitHub until Q1 / 2025.
We plan to have the initial contribution request structure available in the S-CORE GitHub until Q1 / 2025.

We plan to incorporate a staging area for such contributions, but
in the initial phase of the SCORE project (until end of 2025) the focus will be primarily on building a valid 1.0
in the initial phase of the S-CORE project (until end of 2025) the focus will be primarily on building a valid 1.0
release. Feel free to reach out via the communication channels above.

If you think about your contribution to SCORE, the `Feature Request overview <https://github.com/orgs/eclipse-score/projects/4/views/1>`_
If you think about your contribution to S-CORE, the `Feature Request overview <https://github.com/orgs/eclipse-score/projects/4/views/1>`_
is the best place to start.

Based on successful code contributions to the SCORE roadmap, further steps in involvement (like becoming a committer)
Based on successful code contributions to the S-CORE roadmap, further steps in involvement (like becoming a committer)
will be handled according to the rules of the Eclipse Foundation Project Handbook.
We value real code based collaboration and will judge new potential contributors and committers mainly on the validity of their work.
Active and sustaining contributions are the basis for the ability to shape SCORE.
Active and sustaining contributions are the basis for the ability to shape S-CORE.

Making active code contributions via the contribution request process described in the
`SCORE project handbook <https://eclipse-score.github.io/score/platform_management_plan/project_management.html>`_.
`S-CORE project handbook <https://eclipse-score.github.io/score/main/platform_management_plan/project_management.html>`_.
34 changes: 16 additions & 18 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

<div style="visibility: hidden;height:0px;">

SCORE (Eclipse Safe Open Vehicle Core)
######################################
S-CORE (Eclipse Safe Open Vehicle Core)
#######################################

.. raw:: html

Expand Down Expand Up @@ -123,22 +123,22 @@ The tooling used in this project is depicted in the following figure.
:align: center

In general, all tooling is made available as open source and comes either from other open source projects
or is developed in the context of the *SCORE* project. The whole infrastructure is based on a build system called
or is developed in the context of the *S-CORE* project. The whole infrastructure is based on a build system called
`bazel <https://bazel.build/>`_. All workflows such as cloning the repositories, building the software,
generation of documentation, testing and much more are automated using bazel. This provides every project user with
the same user experience. To start working with bazel in the *SCORE* project, you should check
this `introduction page <https://github.com/eclipse-score/blob/main/README.md>`_.
the same user experience. To start working with bazel in the *S-CORE* project to build software and documentation,
you should check this `introduction page <https://github.com/eclipse-score/score/blob/main/README.md>`_.

For documenting the process, requirements and architecture we rely on `sphinx <https://www.sphinx-doc.org/en/master/>`_ and it's extension
`sphinx-needs <https://www.sphinx-needs.com/>`_. For small diagrams we use `PlantUML sphinx-needs extensions <https://sphinx-needs.readthedocs.io/en/stable/directives/needuml.html>`_,
for larger diagrams we use `draw.io <https://github.com/jgraph/drawio-desktop>`_.

We support both C++ and Rust programming languages. Software development is done in both languages. Decision which language to choose is done during
architecture process. In general, C++ should be used only for the existing modules, that are taken over or referenced by the *SCORE* project.
architecture process. In general, C++ should be used only for the existing modules, that are taken over or referenced by the *S-CORE* project.
For new features and components we aim to develop the code mostly in Rust, as it seems to be more suitable for development compliant to ISO 26262:2018.

We use `gtest/gmock <https://github.com/google/googletest>`_ for unit testing and *ITF (Integration testing framework)* for component and integration tests.
*ITF* was originally developed by one of the initial partners of the *SCORE* project and provided to the community as open source project. Integration tests
*ITF* was originally developed by one of the initial partners of the *S-CORE* project and provided to the community as open source project. Integration tests
are executed both in virtual environment and on the reference hardware.

Roadmap
Expand All @@ -151,7 +151,7 @@ Here you can find the preliminary roadmap of the project:
:align: center


Please be aware, that this roadmap will be also transfered to the `GitHub project <https://github.com/orgs/eclipse-score/projects/1>`_.
Please be aware, that this roadmap will be also transferred to the `GitHub project <https://github.com/orgs/eclipse-score/projects/13>`_.
Please follow this link to get the latest state of the planning.

MVP Phase
Expand All @@ -162,16 +162,16 @@ The main goals of the *MVP Phase* are following:
* establish a working infrastructure, that enables every developer of the project to specify
requirements and architecture, implement code and test it accordingly.
* set-up project structure, that covers all aspects of the open source software development including
cooperation between developers and teams, planning, creation of the roadmaps and coordination meetings.
* define a software development process compliant to ISO 26262:2018, that is a prerequiste for any other software development in the project.
cooperation between developers and teams, planning, creation of the roadmap and coordination meetings.
* define a software development process compliant to ISO 26262:2018, that is a prerequisite for any other software development in the project.

A lot of preparation was already done in the background, therefore we are quite optimistic to finish the *MVP Phase*
latest in the beginning of 2025.

Alignment Phase
===============

In the *Alignment Phase* the main goal is to align on the feature architecture and requirements of the *SCORE Platform v1.0*.
In the *Alignment Phase* the main goal is to align on the feature architecture and requirements of the *S-CORE Platform v1.0*.
Additionally it is important to define the roadmap and the order, in which the features should be implemented.

Development Phase
Expand All @@ -185,7 +185,7 @@ the interest of the automotive community to the project.
Series Stability & Evolution Phase
==================================

In this phase the project should be in an well established state and accepted by the community. Continious development
In this phase the project should be in an well established state and accepted by the community. Continuous development
of the features is taking place.

How we Work
Expand All @@ -194,15 +194,13 @@ How we Work
Meetings
========

The following regular meetings (and corresponding meeting minutes) are held as part of the project:
Regular meetings (and corresponding meeting minutes) are held as part of the project:

- `Project Leader Circle <https://github.com/orgs/eclipse-score/discussions/categories/project-lead-circle>`_
- `Teams & Circles <https://github.com/orgs/eclipse-score/discussions>`_

- `Technical Leader Circle <https://github.com/orgs/eclipse-score/discussions/categories/technical-leader-circle>`_
Typically teams and circles meet weekly.

The dates will be announced via the [email protected] mailing list.

We plan to start regular exchange in the scope of the *SCORE* project in December 2024.
A public meeting calendar for the *S-CORE* project is in preparation.

Partners
========
Expand Down