Skip to content

Commit 7991040

Browse files
committed
docs: Integrate content of landing page
Signed-off-by: Philipp Ahmann Signed-off-by: Philipp Ahmann <Philipp.Ahmann@de.bosch.com>
1 parent f928da3 commit 7991040

5 files changed

Lines changed: 46 additions & 53 deletions

File tree

docs/index.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,6 @@ Welcome & Overview
4141

4242
**Welcome to the Software documentation of the SCORE project.**
4343

44-
If this is the first time you get in touch with SCORE, the `SCORE main page <https://eclipse-score.github.io/>`__
45-
may be a good starting point to receive first insights of the project itself.
46-
4744
Introduction
4845
~~~~~~~~~~~~
4946

@@ -84,7 +81,7 @@ Software artifacts
8481

8582
Requirements
8683
^^^
87-
Analyse :ref:`Stakeholder <stakeholder_requirements>` or :ref:`Tool <tool_requirements>` requirements for
84+
Analyze :ref:`Stakeholder <stakeholder_requirements>` requirements for
8885
the work with and implementation inside SCORE.
8986
Or get the complete picture on the :ref:`requirements` page.
9087

@@ -140,5 +137,4 @@ Project structure and processes
140137
Releases <score_releases/index.rst>
141138
process/index
142139
PMP <platform_management_plan/index.rst>
143-
SCORE <https://eclipse-score.github.io>
144140
Eclipse <https://projects.eclipse.org/projects/automotive.score>

docs/introduction/_assets/score_roadmap.drawio.svg

Lines changed: 4 additions & 0 deletions
Loading

docs/introduction/_assets/score_roadmap.svg

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/introduction/get_involved.rst

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,59 +17,59 @@
1717
Get involved
1818
============
1919

20-
How to get in contact with SCORE
21-
--------------------------------
20+
How to get in contact with S-CORE
21+
---------------------------------
2222

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

2525
:Project Mailing List: score-dev@eclipse.org
2626

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

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
29+
| **General Information / Alignment regarding S-CORE as a basis for distributions & products:**
30+
| Contact one of the project leads of S-CORE https://projects.eclipse.org/projects/automotive.score/who
3131
32-
The technical HOWTO regarding involvement into SCORE is described here:
32+
The technical HOWTO regarding involvement into S-CORE is described here:
3333
https://github.com/eclipse-score/score/blob/main/CONTRIBUTION.md
3434

35-
How to get involved into SCORE
36-
------------------------------
35+
How to get involved into S-CORE
36+
-------------------------------
3737

38-
The only way to influence SCORE is TO CONTRIBUTE. Everybody can contribute – SCORE is open.
38+
The only way to influence S-CORE is TO CONTRIBUTE. Everybody can :ref:contribute <contribute> – S-CORE is open.
3939

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)
40+
Active Contributions to the S-CORE project are the basis for getting involved. The S-CORE 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 S-CORE project is discussed and decided in the project lead circle, technical direction is created and upfront in the tech
43+
lead circle. Meeting notes are transparent via the S-CORE github organization. (see https://github.com/orgs/eclipse-score/discussions)
4444

45-
We aim to build a safety ready full stack architecture, where components fit to each other in
45+
We aim to build a safety ready full stack architecture, where components fit to each other in
4646
automotive grade Software Quality and performance. To achieve this, we follow a strict
4747
:ref:`feature roadmap and architecture <releases>`
4848
and a :ref:`rigid software development process <process_description>`
49-
(currently under development).
49+
(currently under development).
5050

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
51+
Contributions to the S-CORE project must therefore follow the technical direction of the project and the S-CORE
52+
architecture. All work in S-CORE will therefore follow a
5353
: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.
54+
Features on the roadmap of S-CORE are defined, Contribution Requests create the basis for individual contributions from
55+
within the S-CORE project and also from the outside.
5656

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.
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 S-CORE, because the S-CORE release roadmap will strictly
59+
comply with the contribution request structure.
60+
We plan to have the initial contribution request structure available in the S-CORE GitHub until Q1 / 2025.
6161

6262
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
63+
in the initial phase of the S-CORE project (until end of 2025) the focus will be primarily on building a valid 1.0
6464
release. Feel free to reach out via the communication channels above.
6565

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

69-
Based on successful code contributions to the SCORE roadmap, further steps in involvement (like becoming a committer)
69+
Based on successful code contributions to the S-CORE roadmap, further steps in involvement (like becoming a committer)
7070
will be handled according to the rules of the Eclipse Foundation Project Handbook.
7171
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.
72+
Active and sustaining contributions are the basis for the ability to shape S-CORE.
7373

7474
Making active code contributions via the contribution request process described in the
7575
:need:`Contribution Request Guideline <gd_guidl__contr_request_guideline>`.

docs/introduction/index.rst

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ including hardware specific peripherals.
8080
Target Picture of Core Stack - PRELIMINARY
8181
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
8282

83-
The following image shows platform architecture in more details including surroundings as
83+
The following image shows platform architecture in more details including surroundings as
8484
Board support package (BSP) and HW specific.
8585

8686
.. image:: _assets/score_architecture_core_stack_target_picture.png
@@ -95,13 +95,12 @@ Roadmap
9595

9696
Here you can find the preliminary roadmap of the project:
9797

98-
.. image:: _assets/score_roadmap.svg
98+
.. image:: _assets/score_roadmap.drawio.svg
9999
:alt: project roadmap
100100
:align: center
101101

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.
102+
Please be aware, that the roadmap is transferred to and maintained in the `GitHub project <https://github.com/orgs/eclipse-score/projects/13/views/2>`_.
103+
Please follow this link to get the latest state of the planning.
105104

106105
MVP Phase
107106
^^^^^^^^^
@@ -111,30 +110,30 @@ The main goals of the *MVP Phase* are following:
111110
* establish a working infrastructure, that enables every developer of the project to specify
112111
requirements and architecture, implement code and test it accordingly.
113112
* 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.
113+
cooperation between developers and teams, planning, creation of the roadmap and coordination meetings.
114+
* define a software development process compliant to ISO 26262:2018, that is a pre-requisite for any other software development in the project.
116115

117116
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.
117+
latest in the beginning of 2025.
119118

120119
Alignment Phase
121120
^^^^^^^^^^^^^^^
122121

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

126125
Development Phase
127126
^^^^^^^^^^^^^^^^^
128127

129128
The *Development Phase* is the phase, where the implementation of the main modules of the platform should happen.
130129
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
130+
The *Release v0.5* milestone will show, whether previously defined software development process will work and how big is the acceptance and
132131
the interest of the automotive community to the project.
133132

134133
Series Stability & Evolution Phase
135134
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
136135

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

140139
How we Work
@@ -143,15 +142,13 @@ How we Work
143142
Meetings
144143
^^^^^^^^
145144

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>`_
145+
Regular meetings (and corresponding meeting minutes) are held as part of the project:
149146

150-
- `Technical Leader Circle <https://github.com/orgs/eclipse-score/discussions/categories/technical-leader-circle>`_
147+
- `Teams & Circles <https://github.com/orgs/eclipse-score/discussions>`_
151148

152-
The dates will be announced via the score-dev@eclipse.org mailing list.
149+
Typically teams and circles meet weekly.
153150

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

156153
Partners
157154
^^^^^^^^

0 commit comments

Comments
 (0)