Bugzilla – Full Text Bug Listing
| Summary: | [release] iot.cyclonedds 0.1.0 | ||
|---|---|---|---|
| Product: | Community | Reporter: | Cydnie Smith <cydnie.smith> |
| Component: | Proposals and Reviews | Assignee: | Eclipse Management Organization <emo> |
| Status: | RESOLVED FIXED | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | CC: | eb, hans.vanthag, michiel.beemster, niels.kortstee, sharon.corbett, wayne.beaton |
| Version: | unspecified | ||
| Target Milestone: | --- | ||
| Hardware: | All | ||
| OS: | All | ||
| URL: | https://projects.eclipse.org/projects/iot.cyclonedds/releases/0.1.0-preambule | ||
| Whiteboard: | |||
|
Description
Cydnie Smith
Dear Cydnie, Please accept my apologies for having gone for "schedule review" too early, when all I wanted to do was notify the PMC ... It's a good thing I'm better with software than with procedures (I hope :)) Thanks, Erik Its no problem! Typically when there is a request for PMC approval, we open the bug as a way to keep track that a release is coming. What does "Preambule" in your version number mean? What do you intend to convey with that? It is the movement that opens the sequence, that sets the stage. It actually is taken from Schumann's Carnaval, which is not only a magnificent piece of music that I know intimately, but is also a good source for a long and delightful series of names while at the same time providing a metaphorical echo to the tension between the two natures of DDS - that of the shared data space and publish-subscribe messaging. Moreover, some of those names are some really nice double-entendres: Florestan and Eusebius are the two very different alter egos of Schumann (see the aforementioned tension) and "Lettres dansantes" is quite apt for a system that can be used as a messaging platform. Besides, it gives a nice point on the horizon: the final movement is the March against the Philistines :) (Naturally without defining who those Philistines are!) But that would be about 20 releases down the road ... so I have some work to do. Alrighty then. I ran into trouble building the project (it couldn't find OpenSSL); while your build script did give me some feedback to sort out how to solve the problem, it might be helpful to provide a list of dependencies that need to be available as part of your build instructions. The project appears to be in pretty good shape. I did notice a handful of branding issues that I'd like you to address, please. The description on the GitHub repo [1] needs to include the full project name, "Eclipse Cyclone DDS"; set the URL to the project's page [2]. Please update the reference to the proposal [3] in the readme to point to the project page [2] (the proposal will no longer evolve and provides no current information about the project). The documentation site [4] needs to use proper branding. Specifically, the first and all prominent occurrences of the project name should be "Eclipse Cyclone DDS". The documentation site also requires a statement that "Eclipse Cyclone DDS" and "Cyclone DDS" are trademarks of the Eclipse Foundation. Where is the source for the documentation maintained? Note that the about page in your documentation points to what I think is the pre-move Git repository. Do you have any plans to move the documentation to www.eclipse.org/cyclonedds/docs (or similar)? [1] https://github.com/eclipse-cyclonedds/cyclonedds [2] https://projects.eclipse.org/projects/iot.cyclonedds [3] https://projects.eclipse.org/proposals/eclipse-cyclone-dds [4] http://cdds.io/docs/ I noticed that you've added a header to some third party content [1]. I checked with the IP team and the Git log and, AFAICT, none of the content was actually changed in this file, so the original license still applies and the header is actually incorrect. Please remove the header. [1] https://github.com/eclipse-cyclonedds/cyclonedds/blob/master/src/os/src/snippets/code/os_stdlib_getopt.c Hi Wayne, Thanks for the feedback: all are excellent points. I expect it will take me a few days to really address all of them as I will have to first have to find out how to generate and upload the documentation ... I'll add a comment when it's done. > I ran into trouble building the project (it couldn't find OpenSSL); while your > build script did give me some feedback to sort out how to solve the problem, it > might be helpful to provide a list of dependencies that need to be available as > part of your build instructions. Will update them. > The description on the GitHub repo [1] needs to include the full project name, > "Eclipse Cyclone DDS"; set the URL to the project's page [2]. Please update the > reference to the proposal [3] in the readme to point to the project page [2] > (the proposal will no longer evolve and provides no current information about > the project). Same. > The documentation site [4] needs to use proper branding. Specifically, the first > and all prominent occurrences of the project name should be "Eclipse Cyclone DDS". > The documentation site also requires a statement that "Eclipse Cyclone DDS" and > "Cyclone DDS" are trademarks of the Eclipse Foundation. Moving the documentation to www.eclipse.org/cyclonedds/docs seems best to me (of course with the occurrences of the project name all updated and trademarks properly identified). That way, everything is in its proper place. I'll also try to get the old documentation site to link to www.eclipse.org/cyclonedds/docs instead. > Where is the source for the documentation maintained? There are doxygen comments in the code and the "getting started" sources are in src/docs. Thanks. There is no urgency to move your documentation. I am merely curious to know what plans, if any, you have to move them. The IP Log is approved. I've gone ahead and scheduled the review to conclude on February 20/2019. We do need PMC approval before we can declare success, so please follow up with them (I see your request, but do not see a response in the archive yet). Hi Wayne, I believe I have made all the requested changes, including updating the documentation. In the process of going over these I found some additional ones as well. I've asked the owner of cdds.io to just point to the eclipse.org and GitHub locations, but that's out of my control. The changes are currently a PR: https://github.com/eclipse-cyclonedds/cyclonedds/pull/113 but it fails to pass the IP validation check, and I can't figure out why: all the commits have matching Author and Signed-off-by. It does include two commits from an old PR (https://github.com/eclipse-cyclonedds/cyclonedds/pull/35) where I know the original author hoped to address the comments but hasn't found the time to do so. But that PR passes the IP validation as well ... So I'm kinda stuck here. Thanks in advance for any help you can provide, Erik Follow up to comment #11: some experimentation shows the problem must have been caused by the two commits that I did not author myself, since leaving them out makes the IP validation succeed. Since those two commits are not at all essential, I have opted to move forward without them. That means I believe all the comments have been addressed and that all commits that were added since the approval of the IP log were my own work. I assume that leaves the IP log in an approved state. Pinged the PMC again as well. There remains open IP CQs for the project code...as a result, this is a gate to release! (In reply to Sharon Corbett from comment #13) > There remains open IP CQs for the project code...as a result, this is a gate > to release! Whoops my mistake! Please ignore! PMC Approval: https://www.eclipse.org/lists/iot-pmc/msg05869.html I declare this review successful! Please continue with your release. |