Skip to content
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

Jump to bottom

Profile hardware - Draft Hardware Profile Submission #947

Open
wants to merge 52 commits into
base: profile-hardware
Choose a base branch
from
Open

Profile hardware - Draft Hardware Profile Submission #947

wants to merge 52 commits into from

Conversation

stevenc-stb
Copy link

This is the draft hardware submission. Please review and advise.

@stevenc-stb
Add Process Obect for HBOM
75be2c5 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add files via upload
b111d39 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add Hardware Class Profile
f7b92b0 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Hardware.md
cdc9d0b 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename xAxis.md to xAxisLength.md
a9c466c 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename yAxis.md to yAxisLength.md
aee5e70 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename zAxis.md to zAxisLength.md
b6d82c6 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMDimensions.md - Change ()Axis to ()AxisLength
6f33d08 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMDimensions.md Fix Capulization
4165756 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/processType.md
2c56078 
Need to move to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add processType to Core
9d5191e 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
131f964 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename type.md to typeOfProcess.md
f0dc396 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
8a0bb7e 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/documentState.md
c930806 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add Document State to the right place.
72bfbef 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
3300866 
Add new Relationship Types 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
47944eb 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
e724862 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update physical.md
719c075 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update status.md
2c37e9b 
Improved clarity 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
25ff6f6 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update informationElementList.md
00d0f4d 
Improved Clarity. 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update physical.md
b35b37c 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update virtualFlag.md
ce6ba53 
Clarity

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update virtualFlag.md
5dbf526 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update coordinateOrientationType.md
e1427b2 
Fix coordinateOrientationType 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/processType.md
89c926c 
Moved to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add files via upload
6db3db4 
move to /Core/Vocabularies/processType.md 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@bact bact added the Profile:Hardware Hardware Profile and related matters label Dec 21, 2024
@bact
Remove extra colon in informationElementList.md
ca45c08 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact requested review from zvr, goneall and kestewart December 21, 2024 18:22
@bact
Copy link
Collaborator

bact commented Dec 21, 2024

@stevenc-stb You can put this PR out of draft anytime you feel ready, so one of the maintainers can merge it. Thank you.

zvr
zvr requested changes Dec 22, 2024
View reviewed changes
Copy link
Member

@zvr zvr left a comment

Choose a reason for hiding this comment

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

I'm not marking typos, etc. in descriptions; these can be fixed later.

model/Core/Classes/Process.md
@@ -0,0 +1,36 @@
SPDX-License-Identifier: Community-Spec-1.0

# Process
Copy link
Member

Choose a reason for hiding this comment

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

This is very confusing.
There is a definition of Process, which is a set of tasks (not found elsewhere), and its status is a document State ?
More explanation is needed, in the text, I think.
And why is it in /Core ?

Copy link
Author

Choose a reason for hiding this comment

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

FuSa and Hardware profiles in the current discussion will need the class. Where should it go if two profiles need it?
i will put the definition of Process on the to-do list for improvement .

model/Core/Properties/status.md

## Description

Draft, active, obsolete or other are used to define the state or status of a proceedure.
Copy link
Member

Choose a reason for hiding this comment

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

It seems this uses "state" and "status" interchangeably. Can you standardize in one?

model/Core/Properties/typeOfProcess.md
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# typeOfProcess
Copy link
Member

Choose a reason for hiding this comment

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

Our usual naming conventions would have it as processType.

Copy link
Author

@stevenc-stb stevenc-stb Dec 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

We are trying to avoid having the property name and the vocabulary name having the same name.

model/Core/Vocabularies/documentState.md Outdated Show resolved Hide resolved
model/Core/Vocabularies/processType.md Outdated Show resolved Hide resolved
model/Hardware/Hardware.md
the following has to hold:


1. for every `/Hardware/Hardware` The property listed under the physical are not available if virtualFlag = true
Copy link
Member

Choose a reason for hiding this comment

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

I think it would be better to have different classes, VirtualHardware and PhysicalHardware (or whatever you want to name them) and have the corresponding properties in the corresponding classes. You may have an abstract Hardware superclass for the common properties.

Copy link
Author

Choose a reason for hiding this comment

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

We will discuss this issue with the HBOM group January 10. What is the main reason for your suggestion?

model/Hardware/Properties/informationElementList.md
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# informationElementList
Copy link
Member

Choose a reason for hiding this comment

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

We'd usually call it simply informationElement, not adding "List"

model/Hardware/Properties/organizationalEntity.md Outdated

## Description

This is the name of the OEM organization for a product.
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be a Relationship between a Product and an Organization ?

The description is not clear what the relationship is: is it the org that conceived, designed, manufactured, sells, buys, uses, ... the product?

Copy link
Author

Choose a reason for hiding this comment

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

In the /Core/Artifact is "originatedBy" property. This is a data property.
What is the forward looking standard we should use in relation to property and relationships?

Update Definition-- please advise

model/Hardware/Vocabularies/coordinateOrientationType.md Outdated Show resolved Hide resolved
model/Hardware/Vocabularies/coordinateOrientationType.md Outdated Show resolved Hide resolved
stevenc-stb and others added 12 commits December 23, 2024 07:33
@stevenc-stb @zvr
Update model/Hardware/Classes/HBOMPhysical.md
2adc10b 
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update documentState.md
7cdb584 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Rename documentState.md to DocumentState.md
27ce819 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename processType.md to ProcessType.md
f529397 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
d20a189 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update coordinateOrientationType.md
ff12907 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Rename coordinateOrientationType.md to CoordinateOrientationType.md
bebfaa1 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMDimensions.md
a422636 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update coordinateOrientation.md
4e4f569 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update status.md
96a1c83 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @zvr
Update model/Hardware/Classes/Hardware.md
e074c7d 
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @zvr
Update model/Hardware/Classes/HBOMPhysical.md
5d84b8c 
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
bact
bact approved these changes Dec 23, 2024
View reviewed changes
Copy link
Collaborator

@bact bact left a comment

Choose a reason for hiding this comment

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

I have put some individual suggestions, please take a look at each of them.

All of them are just suggestions.

The Hardware Profile group may like to discuss this further and may like to put it otherwise -- happy to approve this for now so there can be something on the branch for discussion further.

model/Hardware/Vocabularies/CoordinateOrientationType.md Outdated Show resolved Hide resolved
model/Hardware/Vocabularies/CoordinateOrientationType.md Outdated Show resolved Hide resolved
model/Hardware/Vocabularies/CoordinateOrientationType.md Outdated Show resolved Hide resolved
model/Core/Vocabularies/DocumentState.md Outdated Show resolved Hide resolved
model/Core/Vocabularies/RelationshipType.md Outdated Show resolved Hide resolved
model/Hardware/Classes/HBOMDimensions.md Outdated Show resolved Hide resolved
model/Hardware/Vocabularies/CoordinateOrientationType.md Outdated Show resolved Hide resolved
stevenc-stb and others added 9 commits December 23, 2024 08:51
@stevenc-stb @bact
Update model/Core/Vocabularies/DocumentState.md
e74e271 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Hardware/Classes/HBOMDimensions.md
1be8552 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Core/Vocabularies/RelationshipType.md
4d8790a 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Hardware.md
5857a1d 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update organizationalEntity.md
1182b0c 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
984532c 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
2cf3ea2 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
b5233e1 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
63c9dc7 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb stevenc-stb marked this pull request as ready for review December 23, 2024 16:21
@stevenc-stb
Update organizationalEntity.md
38749c4 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zvr zvr zvr requested changes

@bact bact bact approved these changes

@goneall goneall Awaiting requested review from goneall

@kestewart kestewart Awaiting requested review from kestewart

Assignees
No one assigned
Labels
Profile:Hardware Hardware Profile and related matters
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevenc-stb @bact @zvr