Skip to content

Commit f928da3

Browse files
committed
docs: Integrate content of landing page
Integration of the content of the repository https://github.com/eclipse-score/eclipse-score.github.io The following files from eclipse-score.github.io (commit cab3d09cb3b7ccd04b8487a07fba4a0e72224607) were copied over (and slightly adjusted): - docs/index.rst - docs/get_involved.rst - docs/_assets/score_architecture_core_stack_target_picture.png - docs/_assets/score_architecture_high_level_overview.png - docs/_assets/score_roadmap.svg
1 parent d752cf3 commit f928da3

6 files changed

Lines changed: 251 additions & 3 deletions

File tree

docs/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,21 +56,21 @@ Introduction
5656
^^^
5757
The project develops an open source core stack for Software Defined Vehicles (SDVs),
5858
targeting embedded high-performance Electronic Control Units (ECUs).
59-
Check our `Scope <https://eclipse-score.github.io/#scope>`_ for details.
59+
Check our :ref:`Scope <introduction_scope>` for details.
6060

6161
.. grid-item-card::
6262

6363
Project Status
6464
^^^
6565
Check out our roadmap to see the project's key milestones and features we have planned.
66-
`Click here to explore! <https://eclipse-score.github.io/index.html#roadmap>`_
66+
:ref:`Click here to explore! <introduction_roadmap>`
6767

6868
.. grid-item-card::
6969

7070
How to Contribute?
7171
^^^
7272
The only way to influence Eclipse SCORE is to contribute - SCORE is open! Please check our
73-
`Get Involved <https://eclipse-score.github.io/get_involved.html>`_ guide for more
73+
:ref:`Get Involved <introduction_get_involved>` guide for more
7474
information.
7575

7676

@@ -133,6 +133,7 @@ Project structure and processes
133133
.. toctree::
134134
:maxdepth: 1
135135

136+
introduction/index
136137
requirements/index
137138
features/index
138139
contribute/index
1.01 MB
Loading
474 KB
Loading

docs/introduction/_assets/score_roadmap.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/introduction/get_involved.rst

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2024 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _introduction_get_involved:
16+
17+
Get involved
18+
============
19+
20+
How to get in contact with SCORE
21+
--------------------------------
22+
23+
If you want to get into contact with SCORE, these are your primary entry points:
24+
25+
:Project Mailing List: score-dev@eclipse.org
26+
27+
:Architectural Discussion: `#score-project-channel-public <https://sdvworkinggroup.slack.com/archives/C083Z4VL90B>`__
28+
29+
| **General Information / Alignment regarding SCORE as a basis for distributions & products:**
30+
| Contact one of the project leads of SCORE https://projects.eclipse.org/projects/automotive.score/who
31+
32+
The technical HOWTO regarding involvement into SCORE is described here:
33+
https://github.com/eclipse-score/score/blob/main/CONTRIBUTION.md
34+
35+
How to get involved into SCORE
36+
------------------------------
37+
38+
The only way to influence SCORE is TO CONTRIBUTE. Everybody can contribute – SCORE is open.
39+
40+
Active Contributions to the SCORE project are the basis for getting involved. The SCORE Project works according to
41+
the Eclipse Project Handbook and has named and elected project leads and committers (see https://projects.eclipse.org/projects/automotive.score/who).
42+
Direction of the SCORE project is discussed and decided in the project lead circle, technical direction is created and prediscussed in the tech
43+
lead circle. Meeting notes are transparent via the SCORE github organization. (see https://github.com/orgs/eclipse-score/discussions)
44+
45+
We aim to build a safety ready full stack architecture, where components fit to each other in
46+
automotive grade Software Quality and performance. To achieve this, we follow a strict
47+
:ref:`feature roadmap and architecture <releases>`
48+
and a :ref:`rigid software development process <process_description>`
49+
(currently under development).
50+
51+
Contributions to the SCORE project must therefore follow the technical direction of the project and the SCORE
52+
architecture. All work in SCORE will therefore follow a
53+
:need:`Contribution Request Guideline <gd_guidl__contr_request_guideline>`.
54+
Features on the roadmap of SCORE are defined, Contribution Requests create the basis for individual contributions from
55+
within the SCORE project and also from the outside.
56+
57+
You can make proposals for new features or architectural building blocks besides the active contribution requests.
58+
Those will not by default be part of the next release of SCORE, because the SCORE release roadmap will strictly
59+
comply with the contribution request structure.
60+
We plan to have the initial contribution request structure available in the SCORE GitHub until Q1 / 2025.
61+
62+
We plan to incorporate a staging area for such contributions, but
63+
in the initial phase of the SCORE project (until end of 2025) the focus will be primarily on building a valid 1.0
64+
release. Feel free to reach out via the communication channels above.
65+
66+
If you think about your contribution to SCORE, the `Feature Request overview <https://github.com/orgs/eclipse-score/projects/4/views/1>`_
67+
is the best place to start.
68+
69+
Based on successful code contributions to the SCORE roadmap, further steps in involvement (like becoming a committer)
70+
will be handled according to the rules of the Eclipse Foundation Project Handbook.
71+
We value real code based collaboration and will judge new potential contributors and committers mainly on the validity of their work.
72+
Active and sustaining contributions are the basis for the ability to shape SCORE.
73+
74+
Making active code contributions via the contribution request process described in the
75+
:need:`Contribution Request Guideline <gd_guidl__contr_request_guideline>`.

docs/introduction/index.rst

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2024 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
.. _introduction:
16+
17+
Introduction
18+
============
19+
20+
Background
21+
----------
22+
23+
With the upcoming of central EE architectures in vehicles, computing power has been upgraded on few central components called 'High Performance Computers' or HPC. Together with these computing units comes an upgrade of operating systems towards multi-threaded schedulers with memory and resource separation in processes. There is a gap between these operating systems and the application layer that requires a common interface with functions and features for applications and application domains. The sum of these common and domain-agnostic functions is generally called "Middleware". The project uses the term "Core Software Stack" for this kind of functionality in differentiation to domain specific software stacks.
24+
25+
.. _introduction_scope:
26+
27+
Scope
28+
-----
29+
30+
The scope of this project is the development of an open source core stack for Software Defined Vehicles (SDVs), specifically targeting embedded high-performance Electronic Control Units (ECUs).
31+
32+
Safe Open Vehicle Core is targeting to be the non-differentiating core of a software stack running on HPC ECUs of a software-defined vehicle. Consequently, this project's scope are the "inner layers" of such a stack between a hardware abstraction as its 'lower bound', 'southbound interface' and a platform API towards vehicle function applications as its 'upper bound', 'northbound interface'.
33+
34+
Out of scope are said applications running on this stack (those carry the differentiating aspects covered by adopters of the stack). As well out of scope are any aspects related to a concrete hardware target, which will be freely chosen by each adopter individually, as per the needs of and as they see fit with their vehicle architecture — except support for a potential reference hardware. Furthermore, any off-board functionality (e.g. cloud services) is considered out of scope. Looking beyond mere implementations in code, the project very well considers establishing concepts and implementations of processes, or a "way of doing things", or best practices to be in scope — but only as long as it pertains to making code fit for automotive grade.
35+
36+
Guiding Principles
37+
------------------
38+
The project aims to BUILD THE BEST AUTOMOTIVE RUNTIME SOLUTION ONLY ONCE. To achieve this, it is guided by several key principles.
39+
40+
Common Stack & Industry-Wide Collaboration
41+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
42+
43+
The Safe Open Vehicle Core project aims to create a common full stack solution of a software runtime that serves as the best possible solution for shared industry problems. By achieving efficiencies through a single, joint solution instead of multiple specific ones, the project addresses non-differentiating scopes and ensures that the scope is significant for multiple parties, rather than catering to singular interests.
44+
45+
Speed
46+
^^^^^
47+
48+
The project accelerates development by working in open source, focusing on code-centric and iterative methods rather than primarily on textual specifications.
49+
50+
Abstraction and Extensibility
51+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52+
53+
The project emphasizes the decoupling of hardware (HW) and software (SW), ensuring that applications do not depend on specific hardware characteristics. It establishes predetermined breaking points to enable the exchange of implementations of individual layers, aspects, and components, such as ECU communication protocols. Additionally, it focuses on enabling project-specific extensions of the stack, providing a flexible framework that can be customized and extended to meet the specific requirements of different projects.
54+
55+
Quality & Efficiency
56+
^^^^^^^^^^^^^^^^^^^^
57+
58+
The Safe Open Vehicle Core project aims for a lean, no-frills solution to lower complexity and increase efficiency. The project strives for support of modern implementation paradigms and languages like Rust or C++, uses human-readable specification languages that are domain and target-driven, and avoids complex exchange data formats. It seeks the optimal balance between modularity and resource consumption and follows state-of-the-art processes to develop safe and secure software in an open source environment.
59+
60+
61+
62+
By achieving these goals and adhering to these key principles, the Safe Open Vehicle Core Project aims to deliver a versatile, safe and secure core stack that supports the evolving needs of the automotive industry and accelerates the adoption of software-defined vehicle technologies.
63+
64+
Architecture
65+
------------
66+
67+
The following figures show a draft version of the planned architecture of the core stack. The architecture will be refined further as part of the project.
68+
69+
High Level View on the Core Stack
70+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
71+
72+
The following high level architecture picture gives you an overview of the main platform building blocks
73+
including hardware specific peripherals.
74+
75+
.. image:: _assets/score_architecture_high_level_overview.png
76+
:width: 900
77+
:alt: High level view on the core stack
78+
:align: center
79+
80+
Target Picture of Core Stack - PRELIMINARY
81+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
82+
83+
The following image shows platform architecture in more details including surroundings as
84+
Board support package (BSP) and HW specific.
85+
86+
.. image:: _assets/score_architecture_core_stack_target_picture.png
87+
:width: 900
88+
:alt: Target picture the core stack (preliminary)
89+
:align: center
90+
91+
.. _introduction_roadmap:
92+
93+
Roadmap
94+
-------
95+
96+
Here you can find the preliminary roadmap of the project:
97+
98+
.. image:: _assets/score_roadmap.svg
99+
:alt: project roadmap
100+
:align: center
101+
102+
103+
Please be aware, that this roadmap will be also transfered to the `GitHub project <https://github.com/orgs/eclipse-score/projects/1>`_.
104+
Please follow this link to get the latest state of the planning.
105+
106+
MVP Phase
107+
^^^^^^^^^
108+
109+
The main goals of the *MVP Phase* are following:
110+
111+
* establish a working infrastructure, that enables every developer of the project to specify
112+
requirements and architecture, implement code and test it accordingly.
113+
* set-up project structure, that covers all aspects of the open source software development including
114+
cooperation between developers and teams, planning, creation of the roadmaps and coordination meetings.
115+
* define a software development process compliant to ISO 26262:2018, that is a prerequiste for any other software development in the project.
116+
117+
A lot of preparation was already done in the background, therefore we are quite optimistic to finish the *MVP Phase*
118+
latest in the beginning of 2025.
119+
120+
Alignment Phase
121+
^^^^^^^^^^^^^^^
122+
123+
In the *Alignment Phase* the main goal is to align on the feature architecture and requirements of the *SCORE Platform v1.0*.
124+
Additionally it is important to define the roadmap and the order, in which the features should be implemented.
125+
126+
Development Phase
127+
^^^^^^^^^^^^^^^^^
128+
129+
The *Development Phase* is the phase, where the implementation of the main modules of the platform should happen.
130+
The most important milestone here is the *Release v0.5*, that should contain the basic modules, e.g *IPC*.
131+
The *Release v0.5* milestone will show, whether previously defined software development process will work and how big is the acceptance and
132+
the interest of the automotive community to the project.
133+
134+
Series Stability & Evolution Phase
135+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
136+
137+
In this phase the project should be in an well established state and accepted by the community. Continious development
138+
of the features is taking place.
139+
140+
How we Work
141+
-----------
142+
143+
Meetings
144+
^^^^^^^^
145+
146+
The following regular meetings (and corresponding meeting minutes) are held as part of the project:
147+
148+
- `Project Leader Circle <https://github.com/orgs/eclipse-score/discussions/categories/project-lead-circle>`_
149+
150+
- `Technical Leader Circle <https://github.com/orgs/eclipse-score/discussions/categories/technical-leader-circle>`_
151+
152+
The dates will be announced via the score-dev@eclipse.org mailing list.
153+
154+
We plan to start regular exchange in the scope of the *SCORE* project in December 2024.
155+
156+
Partners
157+
^^^^^^^^
158+
159+
The people working in this project are listed `here <https://projects.eclipse.org/projects/automotive.score/who>`_.
160+
161+
162+
How to contribute
163+
^^^^^^^^^^^^^^^^^
164+
165+
.. toctree::
166+
:maxdepth: 1
167+
168+
get_involved.rst

0 commit comments

Comments
 (0)