Skip to content

Commit bf1aee8

Browse files
authored
Merge pull request #86 from CSA-FEDERATE/Rework_BB_Description
Rework bb descriptions
2 parents c80c906 + 6a0e940 commit bf1aee8

167 files changed

Lines changed: 2128 additions & 766 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/00_BB_creation_template.yml

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ body:
104104
id: usage_example
105105
attributes:
106106
label: BB Usage
107-
description: Example on how to use BB or link to documentation
107+
description: Example on how to use BB or link to documentation. Should include code snippets, information about usage, trainings, skills, examples and how-to's.
108108
placeholder:
109109
validations:
110110
required: false
@@ -232,7 +232,7 @@ body:
232232
- type: textarea
233233
id: rel_projects
234234
attributes:
235-
label: Related Project(s)
235+
label: Contribution supported by RDI projects
236236
description: If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value, If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework
237237
placeholder:
238238
validations:
@@ -412,15 +412,6 @@ body:
412412
validations:
413413
required: false
414414

415-
- type: textarea
416-
id: sys_context
417-
attributes:
418-
label: System Context
419-
description: OS and runtime/framework requirements eg. AGL, QNX, ROS-based, container runtime, web assembly, web service
420-
placeholder:
421-
validations:
422-
required: false
423-
424415
- type: dropdown
425416
id: state
426417
attributes:
@@ -437,6 +428,15 @@ body:
437428
validations:
438429
required: true
439430

431+
- type: textarea
432+
id: sys_context
433+
attributes:
434+
label: System Context
435+
description: OS and runtime/framework requirements eg. AGL, QNX, ROS-based, container runtime, web assembly, web service
436+
placeholder:
437+
validations:
438+
required: false
439+
440440
- type: checkboxes
441441
id: bazel
442442
attributes:

BB-CEST/BB_Eclipse_CSP.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
21
# Eclipse Connected Services Platform
3-
42
## BB Tags(s)
53
<!-- Tag(s) define in which area(s) (cloud, in-vehicle) the BB is executed, and what type of BB it is (tool, process, microservice) -->
64
BB-CSC, BB-CSC-TC, BB-CEST, BB-SC
@@ -13,7 +11,9 @@ BB-CSC, BB-CSC-TC, BB-CEST, BB-SC
1311
APPLayer
1412

1513
## BB Usage
16-
<!-- example on how to use BB or link to documentation -->
14+
<!-- Example on how to use BB or link to documentation. Should include code snippets, information about usage,
15+
trainings, skills, examples and how-to's. -->
16+
1717

1818
## Known Implementation
1919
https://eclipse-ecsp.github.io/ecsp-website/
@@ -67,9 +67,9 @@ Eclipse Foundation
6767
## Priority
6868
<!-- High, Medium, Low -->
6969

70-
## Related Project(s)
70+
## Contribution supported by RDI projects
7171
<!-- If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value,
72-
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework -->
72+
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework) -->
7373
TBD
7474

7575
## Availability of Source Code
@@ -116,7 +116,6 @@ Example:
116116
TBD
117117

118118
## State (+ date of last change)
119-
120119
<!--
121120
- Incubating (no code yet)
122121
- Implementation started
@@ -128,7 +127,6 @@ TBD
128127
First public release available
129128

130129
## System Context
131-
132130
<!--
133131
OS and runtime/framework requirements
134132

BB-CEST/Data-Processing-and-Management/BB_Eclipse_TractusX.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
21
# Eclipse Tractus-X
3-
42
## BB Tags(s)
53
<!-- Tag(s) define in which area(s) (cloud, in-vehicle) the BB is executed, and what type of BB it is (tool, process, microservice) -->
64
BB-CEST
@@ -13,7 +11,9 @@ BB-CEST
1311
APPLayer
1412

1513
## BB Usage
16-
<!-- example on how to use BB or link to documentation -->
14+
<!-- Example on how to use BB or link to documentation. Should include code snippets, information about usage,
15+
trainings, skills, examples and how-to's. -->
16+
1717

1818
## Known Implementation
1919
https://github.com/eclipse-tractusx
@@ -67,9 +67,9 @@ Eclipse Foundation
6767
## Priority
6868
<!-- High, Medium, Low -->
6969

70-
## Related Project(s)
70+
## Contribution supported by RDI projects
7171
<!-- If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value,
72-
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework -->
72+
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework) -->
7373
TBD
7474

7575
## Availability of Source Code
@@ -116,7 +116,6 @@ Example:
116116
TBD
117117

118118
## State (+ date of last change)
119-
120119
<!--
121120
- Incubating (no code yet)
122121
- Implementation started
@@ -128,7 +127,6 @@ TBD
128127
First public release available
129128

130129
## System Context
131-
132130
<!--
133131
OS and runtime/framework requirements
134132
@@ -145,4 +143,4 @@ eg.
145143

146144
## Bazel compliance status
147145
<!-- The S-CORE project requires all BB contributions to be ready for BAZEL compliant (https://github.com/bazelbuild/bazel)-->
148-
n/a
146+
n/a

BB-CEST/Development-Testing-and-Simulation-Environments/Simulation-and-Emulation-Tools/BB_Eclipse_Cloe.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Eclipse Cloe
2-
32
## BB Tags(s)
43
<!-- Tag(s) define in which area(s) (cloud, in-vehicle) the BB is executed, and what type of BB it is (tool, process, microservice) -->
54
BB-CEST, BB-CSC-TC
@@ -12,7 +11,9 @@ BB-CEST, BB-CSC-TC
1211
AppLayer
1312

1413
## BB Usage
15-
<!-- example on how to use BB or link to documentation -->
14+
<!-- Example on how to use BB or link to documentation. Should include code snippets, information about usage,
15+
trainings, skills, examples and how-to's. -->
16+
1617

1718
## Known Implementation
1819
https://cloe.readthedocs.io/en/latest/
@@ -49,6 +50,7 @@ TBD
4950
E.g. BB-SC StateManagement
5051
BB is a composition of other BBs -->
5152

53+
5254
## What is needed to Design and Implement
5355
<!-- e.g. we expect to have a certain HW capability and or SW environment or Tool support, or a documentation, or an extra audit, or Test, or Compiler, or Prog. Language, … -->
5456

@@ -69,15 +71,16 @@ TBD
6971
If “No” – nothing more to do
7072
If “Yes, proposal for additional Signals/Information – what should be made available, and where e.g. via (COVESA) VSS/VISS -->
7173

74+
7275
## Author/Company
7376
Eclipse Foundation
7477

7578
## Priority
7679
<!-- High, Medium, Low -->
7780

78-
## Related Project(s)
81+
## Contribution supported by RDI projects
7982
<!-- If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value,
80-
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework -->
83+
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework) -->
8184
TBD
8285

8386
## Availability of Source Code
@@ -124,7 +127,6 @@ Example:
124127
TBD
125128

126129
## State (+ date of last change)
127-
128130
<!--
129131
- Incubating (no code yet)
130132
- Implementation started
@@ -136,7 +138,6 @@ TBD
136138
First public release available
137139

138140
## System Context
139-
140141
<!--
141142
OS and runtime/framework requirements
142143
@@ -153,4 +154,4 @@ TBD
153154

154155
## Bazel compliance status
155156
<!-- The S-CORE project requires all BB contributions to be ready for BAZEL compliant (https://github.com/bazelbuild/bazel)-->
156-
n/a
157+
n/a

BB-CEST/Development-Testing-and-Simulation-Environments/Simulation-and-Emulation-Tools/BB_Eclipse_Mosaic.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Eclipse Mosaic
2-
32
## BB Tags(s)
43
<!-- Tag(s) define in which area(s) (cloud, in-vehicle) the BB is executed, and what type of BB it is (tool, process, microservice) -->
54
BB-CEST, BB-CSC-TC
@@ -12,7 +11,9 @@ BB-CEST, BB-CSC-TC
1211
AppLayer
1312

1413
## BB Usage
15-
<!-- example on how to use BB or link to documentation -->
14+
<!-- Example on how to use BB or link to documentation. Should include code snippets, information about usage,
15+
trainings, skills, examples and how-to's. -->
16+
1617

1718
## Known Implementation
1819
https://github.com/eclipse-mosaic/mosaic
@@ -38,6 +39,7 @@ TBD
3839
E.g. BB-SC StateManagement
3940
BB is a composition of other BBs -->
4041

42+
4143
## What is needed to Design and Implement
4244
<!-- e.g. we expect to have a certain HW capability and or SW environment or Tool support, or a documentation, or an extra audit, or Test, or Compiler, or Prog. Language, … -->
4345

@@ -58,15 +60,16 @@ TBD
5860
If “No” – nothing more to do
5961
If “Yes, proposal for additional Signals/Information – what should be made available, and where e.g. via (COVESA) VSS/VISS -->
6062

63+
6164
## Author/Company
6265
Eclipse Foundation
6366

6467
## Priority
6568
<!-- High, Medium, Low -->
6669

67-
## Related Project(s)
70+
## Contribution supported by RDI projects
6871
<!-- If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value,
69-
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework -->
72+
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework) -->
7073
TBD
7174

7275
## Availability of Source Code
@@ -113,7 +116,6 @@ Example:
113116
TBD
114117

115118
## State (+ date of last change)
116-
117119
<!--
118120
- Incubating (no code yet)
119121
- Implementation started
@@ -125,7 +127,6 @@ TBD
125127
First public release available
126128

127129
## System Context
128-
129130
<!--
130131
OS and runtime/framework requirements
131132
@@ -142,4 +143,4 @@ TBD
142143

143144
## Bazel compliance status
144145
<!-- The S-CORE project requires all BB contributions to be ready for BAZEL compliant (https://github.com/bazelbuild/bazel)-->
145-
n/a
146+
n/a

BB-CEST/Development-Testing-and-Simulation-Environments/Simulation-and-Emulation-Tools/BB_Eclipse_SCM.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Eclipse SCM
2-
32
## BB Tags(s)
43
<!-- Tag(s) define in which area(s) (cloud, in-vehicle) the BB is executed, and what type of BB it is (tool, process, microservice) -->
54
BB-CEST, BB-CSC-TC
@@ -12,7 +11,9 @@ BB-CEST, BB-CSC-TC
1211
AppLayer
1312

1413
## BB Usage
15-
<!-- example on how to use BB or link to documentation -->
14+
<!-- Example on how to use BB or link to documentation. Should include code snippets, information about usage,
15+
trainings, skills, examples and how-to's. -->
16+
1617

1718
## Known Implementation
1819
https://gitlab.eclipse.org/eclipse/scm/scm
@@ -39,6 +40,7 @@ TBD
3940
E.g. BB-SC StateManagement
4041
BB is a composition of other BBs -->
4142

43+
4244
## What is needed to Design and Implement
4345
<!-- e.g. we expect to have a certain HW capability and or SW environment or Tool support, or a documentation, or an extra audit, or Test, or Compiler, or Prog. Language, … -->
4446

@@ -59,15 +61,16 @@ TBD
5961
If “No” – nothing more to do
6062
If “Yes, proposal for additional Signals/Information – what should be made available, and where e.g. via (COVESA) VSS/VISS -->
6163

64+
6265
## Author/Company
6366
Eclipse Foundation
6467

6568
## Priority
6669
<!-- High, Medium, Low -->
6770

68-
## Related Project(s)
71+
## Contribution supported by RDI projects
6972
<!-- If Yes – e.g. The BB should be used/added in the Eclipse Blueprint A – for demo purposes, show added value,
70-
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework -->
73+
If No – Project Proposal (e.g. WP4 in FEDERATE, or in the SDV EcoSystem Community Framework) -->
7174
TBD
7275

7376
## Availability of Source Code
@@ -114,7 +117,6 @@ Example:
114117
TBD
115118

116119
## State (+ date of last change)
117-
118120
<!--
119121
- Incubating (no code yet)
120122
- Implementation started
@@ -126,7 +128,6 @@ TBD
126128
First public release available
127129

128130
## System Context
129-
130131
<!--
131132
OS and runtime/framework requirements
132133
@@ -143,4 +144,4 @@ TBD
143144

144145
## Bazel compliance status
145146
<!-- The S-CORE project requires all BB contributions to be ready for BAZEL compliant (https://github.com/bazelbuild/bazel)-->
146-
n/a
147+
n/a

0 commit comments

Comments
 (0)