Skip to content

Commit b6fc726

Browse files
committed
docs: update naming to s-core
Implements: #17 Signed-off-by: Philipp Ahmann <[email protected]>
1 parent cab3d09 commit b6fc726

File tree

4 files changed

+36
-36
lines changed

4 files changed

+36
-36
lines changed

docs/_assets/css/score.css

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ html {
66
text-decoration: underline;
77
}
88

9-
/* SCORE specfic colors
9+
/* S-CORE specfic colors
1010
A list of available colro variable names for pyData Sphinx Theme can be found at
1111
https://pydata-sphinx-theme.readthedocs.io/en/stable/_downloads/565fbb3ecf2b3048f5fb3953890ba176/_color.scss
1212
@@ -75,7 +75,7 @@ ul.navbar-nav li a {
7575
.toc-entry a.nav-link {
7676
color: var(--pst-color-text-base);
7777
}
78-
/* Left, top SCORE brand */
78+
/* Left, top S-CORE brand */
7979
.navbar-brand p
8080
{
8181
color: var(--pst-color-text-muted);
@@ -118,7 +118,7 @@ blockquote {
118118
background-color: rgba(0,0,0,0.1);
119119
}
120120

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

124124
div.score_banner {

docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
# -- Project information -----------------------------------------------------
2020
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
2121

22-
project = "SCORE"
22+
project = "S-CORE"
2323
copyright = "2024, Score"
24-
author = "SCORE committers"
24+
author = "S-CORE committers"
2525
release = "0.1"
2626

2727
# -- General configuration ---------------------------------------------------

docs/get_involved.rst

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,59 +20,59 @@
2020
Get involved
2121
============
2222

23-
How to get in contact with SCORE
24-
--------------------------------
23+
How to get in contact with S-CORE
24+
---------------------------------
2525

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

2828
:Project Mailing List: [email protected]
2929

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

32-
| **General Information / Alignment regarding SCORE as a basis for distributions & products:**
33-
| Contact one of the project leads of SCORE https://projects.eclipse.org/projects/automotive.score/who
32+
| **General Information / Alignment regarding S-CORE as a basis for distributions & products:**
33+
| Contact one of the project leads of S-CORE https://projects.eclipse.org/projects/automotive.score/who
3434
35-
The technical HOWTO regarding involvement into SCORE is described here:
35+
The technical HOWTO regarding involvement into S-CORE is described here:
3636
https://github.com/eclipse-score/score/blob/main/CONTRIBUTION.md
3737

38-
How to get involved into SCORE
39-
------------------------------
38+
How to get involved into S-CORE
39+
-------------------------------
4040

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

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

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

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

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

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

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

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

7777
Making active code contributions via the contribution request process described in the
78-
`SCORE project handbook <https://eclipse-score.github.io/score/platform_management_plan/project_management.html>`_.
78+
`S-CORE project handbook <https://eclipse-score.github.io/score/platform_management_plan/project_management.html>`_.

docs/index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616

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

19-
SCORE (Eclipse Safe Open Vehicle Core)
20-
######################################
19+
S-CORE (Eclipse Safe Open Vehicle Core)
20+
#######################################
2121

2222
.. raw:: html
2323

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

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

132132
For documenting the process, requirements and architecture we rely on `sphinx <https://www.sphinx-doc.org/en/master/>`_ and it's extension
133133
`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>`_,
134134
for larger diagrams we use `draw.io <https://github.com/jgraph/drawio-desktop>`_.
135135

136136
We support both C++ and Rust programming languages. Software development is done in both languages. Decision which language to choose is done during
137-
architecture process. In general, C++ should be used only for the existing modules, that are taken over or referenced by the *SCORE* project.
137+
architecture process. In general, C++ should be used only for the existing modules, that are taken over or referenced by the *S-CORE* project.
138138
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.
139139

140140
We use `gtest/gmock <https://github.com/google/googletest>`_ for unit testing and *ITF (Integration testing framework)* for component and integration tests.
141-
*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
141+
*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
142142
are executed both in virtual environment and on the reference hardware.
143143

144144
Roadmap
@@ -171,7 +171,7 @@ latest in the beginning of 2025.
171171
Alignment Phase
172172
===============
173173

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

177177
Development Phase
@@ -202,7 +202,7 @@ The following regular meetings (and corresponding meeting minutes) are held as p
202202

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

205-
We plan to start regular exchange in the scope of the *SCORE* project in December 2024.
205+
We plan to start regular exchange in the scope of the *S-CORE* project in December 2024.
206206

207207
Partners
208208
========

0 commit comments

Comments
 (0)