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.

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

Profile hardware - Draft Hardware Profile Submission #947

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

Conversation

stevenc-stb
Copy link

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

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Need to move to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Add new Relationship Types 

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Improved clarity 

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Improved Clarity. 

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Clarity

Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Fix coordinateOrientationType 

Signed-off-by: stevenc-stb <[email protected]>
Moved to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <[email protected]>
move to /Core/Vocabularies/processType.md 

Signed-off-by: stevenc-stb <[email protected]>
@bact bact added the Profile:Hardware Hardware Profile and related matters label Dec 21, 2024
@bact bact requested a review from 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.

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.

@@ -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 .


## 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?

@@ -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

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
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?

@@ -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 Show resolved Hide resolved
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
Co-authored-by: Alexios Zavras (zvr) <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Alexios Zavras (zvr) <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Alexios Zavras (zvr) <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
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
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
Co-authored-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: stevenc-stb <[email protected]>
@stevenc-stb stevenc-stb marked this pull request as ready for review December 23, 2024 16:21
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# centerofMass
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# centerofMass
# centerOfMass

Should this be centerOfMass (Of with big O), the same as typeOfProcess ?

@bact
Copy link
Collaborator

bact commented Jan 7, 2025

I can see that we are starting have more properties related to value+unit (mass+massUnit and dimensions+dimensionsUnit here, energyQuantity+energyUnit in AI), may be in 3.1 we consider patterns used in https://schema.org/QuantitativeValue ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Profile:Hardware Hardware Profile and related matters
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants