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

[GSMG] Add new object type #593

Draft
wants to merge 58 commits into
base: main
Choose a base branch
from
Draft

[GSMG] Add new object type #593

wants to merge 58 commits into from

Conversation

mseich
Copy link
Member

@mseich mseich commented Mar 15, 2024

No description provided.

@albertmink albertmink added the new-object This is a new object type added to AFF label Mar 15, 2024
Copy link
Contributor

@wurzka wurzka left a comment

Choose a reason for hiding this comment

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

Hi @mseich, thanks for uploading the GSMG file format! Please see my comments below.
I'm afraid I didn't express myself precisely enough with regard to the descriptions when we talked about it. They should be in sentence case, but the titles (the shorttexts) in title case.

file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
file-formats/gsmg/README.md Outdated Show resolved Hide resolved
},
"generalInformation": {
"type": "USAGE",
"detailedDescription": "This Metric Group is for testing"
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this description about? Is it an extension of the description field in the header? So like the name says, is it for describing the object in more detail than the header-description allows?

Copy link
Member Author

Choose a reason for hiding this comment

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

Exactly right :-)

Copy link
Contributor

Choose a reason for hiding this comment

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

Just some additional questions: Did you thought about extending the standard description to 255 characters. As far as I know, this should be possible.

If it is more a documentation. Did you consider to provide documentation using KTD?

@mseich mseich requested review from wurzka and schneidermic0 March 22, 2024 09:55
Copy link
Contributor

@schneidermic0 schneidermic0 left a comment

Choose a reason for hiding this comment

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

In general, it looks quite good. Just some minor issues.

Please see also my question regarding the detailedDescription. I followed-up on @wurzka's question. (see above)

file-formats/gsmg/README.md Outdated Show resolved Hide resolved
file-formats/gsmg/examples/z_aff_example_gsmg.gsmg.json Outdated Show resolved Hide resolved
file-formats/gsmg/type/zif_aff_gsmg_v1.intf.abap Outdated Show resolved Hide resolved
},
"generalInformation": {
"type": "USAGE",
"detailedDescription": "This Metric Group is for testing"
Copy link
Contributor

Choose a reason for hiding this comment

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

Just some additional questions: Did you thought about extending the standard description to 255 characters. As far as I know, this should be possible.

If it is more a documentation. Did you consider to provide documentation using KTD?

Copy link
Contributor

@schneidermic0 schneidermic0 left a comment

Choose a reason for hiding this comment

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

Thanks for your update.

Did you see my question related to the detailedDescription field?

Copy link
Contributor

@schneidermic0 schneidermic0 left a comment

Choose a reason for hiding this comment

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

Thanks, @mseich. Looks good to me, now.

@schneidermic0 schneidermic0 requested a review from a team May 7, 2024 13:49
@albertmink albertmink added the ux-review ready AFF is ready for UX review label Jul 22, 2024
@wurzka wurzka removed the request for review from a team September 10, 2024 09:34
@schneidermic0
Copy link
Contributor

@mseich @albertmink As far as I can see the UX cross check did took place. I see only one open question. Should the order of co_category be changed to an alphabetical order?

If it is fine as it is now (non-alphabetic), I think, we could merge this PR.

@wurzka wurzka marked this pull request as draft November 13, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-object This is a new object type added to AFF ux-review ready AFF is ready for UX review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants