search

eclipse / microprofile-sandbox

Apache License 2.0
38 stars 54 forks source link

Update README to address some comments from the community #94

Closed Emily-Jiang closed 2 years ago

Emily-Jiang commented 2 years ago

@JanWesterkamp-iJUG please take a look to see whether you have any suggestions

radcortez commented 2 years ago

Do we really want to get rid of the original document? I believe @JanWesterkamp-iJUG added it here for us to keep a tracking history which lead to many of our decisions.

If we want to provide some different context, my recommendation is to just move this to a different document and add the new content of the README.

Emily-Jiang commented 2 years ago

Do we really want to get rid of the original document? I believe @JanWesterkamp-iJUG added it here for us to keep a tracking history which lead to many of our decisions.

If we want to provide some different context, my recommendation is to just move this to a different document and add the new content of the README.

I believe the original context is no longer needed as most of them ended up in the spec doc. I don't really see the benefit of keeping the dialogue (in-flight) in the readme though.

radcortez commented 2 years ago

I believe the original context is no longer needed as most of them ended up in the spec doc. I don't really see the benefit of keeping the dialogue (in-flight) in the readme though.

What do you think @JanWesterkamp-iJUG, since you heavily pushed for this?

Emily-Jiang commented 2 years ago

@JanWesterkamp-iJUG can you take a look at the PR today as discussed yesterday?

JanWesterkamp-iJUG commented 2 years ago

Do we really want to get rid of the original document? I believe @JanWesterkamp-iJUG added it here for us to keep a tracking history which lead to many of our decisions.

If we want to provide some different context, my recommendation is to just move this to a different document and add the new content of the README.

Basically, it was my intention to put the original document to a different place, so the README could be used like intended now. But I can extract the original document from the Git history and put it on a new doc maven submodule, where we can keep such design decissions. May be it could end as a set of ADRs (Architecture Design Record) there in the future.

Emily-Jiang commented 2 years ago

Do we really want to get rid of the original document? I believe @JanWesterkamp-iJUG added it here for us to keep a tracking history which lead to many of our decisions. If we want to provide some different context, my recommendation is to just move this to a different document and add the new content of the README.

Basically, it was my intention to put the original document to a different place, so the README could be used like intended now. But I can extract the original document from the Git history and put it on a new doc maven submodule, where we can keep such design decissions. May be it could end as a set of ADRs (Architecture Design Record) there in the future.

I think the history can be kept as a github discussion or wiki on Jakarta OpenTelemetry.

Emily-Jiang commented 2 years ago

@JanWesterkamp-iJUG do you have any objections with merging this PR?

JanWesterkamp-iJUG commented 2 years ago

Hi Emily,

you should be informed about my further comments already.

But, as mentioned, you can move forward and we will change the README again, if necessary in a later separate PR.

Best, Jan

Am 01.02.22 um 18:55 schrieb Emily Jiang:

@JanWesterkamp-iJUG https://github.com/JanWesterkamp-iJUG do you have any objections with merging this PR?

— Reply to this email directly, view it on GitHub https://github.com/eclipse/microprofile-sandbox/pull/94#issuecomment-1027125302, or unsubscribe https://github.com/notifications/unsubscribe-auth/AUM254QSLWSM4VB3VJNVATLUZAM7JANCNFSM5MWVHCLA. Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

You are receiving this because you were mentioned.Message ID: @.***>

JanWesterkamp-iJUG commented 2 years ago

Do we really want to get rid of the original document? I believe @JanWesterkamp-iJUG added it here for us to keep a tracking history which lead to many of our decisions. If we want to provide some different context, my recommendation is to just move this to a different document and add the new content of the README.

Basically, it was my intention to put the original document to a different place, so the README could be used like intended now. But I can extract the original document from the Git history and put it on a new doc maven submodule, where we can keep such design decissions. May be it could end as a set of ADRs (Architecture Design Record) there in the future.

I think the history can be kept as a github discussion or wiki on Jakarta OpenTelemetry.

It should stay on MicroProfile ;-) Wiki would be an option, but then the content is somewhere at github and not in the local developer repo - therefore I would like to add it into the spec source and maintain it there. That would offer to use more design elements too, as oposed supported at the GitHub Wiki, like generating diagrams etc. I would like to add later a few drawings regarding the architecure too.