2019- Technical White Paper Pro Bono by Lars RÖWEKAMP!

[aeiras]

MP google drive
MP forum thread

draft v.3

[MBJuric]

Hi,
For the Lessons learned from real-world microservice adoption section, I have gone through all the comments. Thank you for the constructive feedback, it has improved the section.
I have resolved all the comments, except two, which need further discussion.
If you have additional suggestions how to improve the section, please let me know. The only thing I can think of would be to add a CIO statement from one of the companies we are working with, if this would make sense?
Thanks,
Matjaz

[aeiras]

Thank you for moving the private thread to this issue @MBJuric! Super fun to follow process OSS--
I have added 2nd review round to my calendar for this week. 💯 on it! :)

Quickly added to the document comments for Lars about our internal exchange to adjust your name as part of the Contributor's section (at the end of the document instead of the section- Markus from Lightbend, also is part of the individual section, like you)
The goal is to make sure all contributors are listed in the same place to avoid distractions from content.

[aeiras]

@rsjames we have moved the white paper conversations to git as part of alignment of all past and current Branding projects of 2019.

We are coming to the end of the writing of the write paper so this pulls you in to provide feedback first. :)

Should your time be allocated to this project, you are NOT yet:

1. How much time would it take you to get it ready MP design awesomenss ready?
   Ready means:

• branding/design
  we will need to work on what the design will need, for that should you take the design project= an issue will need to be created to enable follow up... stand by--

• addition to MP site under resources and main page

• etc

[aeiras]

@rsjames please check above message for you. Thanks

[rstjames]

If we all feel the white paper has been looked over enough. We can move it to design.
The document is 18 pages now. I am estimating when formatted the pages could be 30-40 pages.

From a design point of view a white paper has not been done before so creating a styling will take sometime.
Estimated design time 5-7 +-
After the initial design is done. Time should be given for comments. Depending on how many comments and adjustments their are will add time to the delivery.

[aeiras]

@mblevins65 this document is +18 pages and it is the first technical paper of the project.

Can you prioritize its edit/grammar review this week.
We hope to start its design next week. Thanks!

[aeiras]

OK, version .4 invites the design face to come into effect.
Draft v.04

Peggy will complete the copy/edit of document before design starts.

[mblevins65]

I went into the doc through the link you sent and made suggestions. I didn't know I had to repeat them here. I made several suggestions via google doc. Check document pages.

[aeiras]

Repeat them here? @mblevins65

Updates of work completed go here via comments Peggy.
If you skip this step, Those who are active collaborators in the document are notified of progress & can check the changes done.

[aeiras]

Your msg above works perfect.

[mblevins65]

page 1 This is among others mainly because of there is lack of a centralized runtime in the design of any distributed system. This sentence is confusing. Possibly replace the words there is with an a.

[mblevins65]

page 5 Therefore, we have to build up our microservices architecture to be resilient and fault tolerant by design. I placed a comma after therefore.

[mblevins65]

page 11 For the clients and providers of these services to connect, there needs to be a clear and complete contract. I placed a comma after connect to clarify the sentence.

[mblevins65]

page 16 In January 2017, MicroProfile become an official Eclipse project. Change become to became.

[mblevins65]

page 17 and Payara demoed a unified web application with underlying microservices Replace the word demoed with demonstrated

[mblevins65]

page 18 After having reached an adequate degree of maturity, the initiator of the sandbox project can ask for a MicroProfile repository and in this way start the MicroProfile feature init process. I placed a comma after the word maturity to clarify sentence.

[mblevins65]

I am sincerely impressed with how well written this project is. Congratulations. I am finished with editing.

[rstjames]

@aeiras would you like to give the green light to move this forward?

[aeiras]

@rstjames:

lets collaborate via new issues for 100% of all the tasks that will take to complete the final step of the project.

• If you have a question, create an issue and add me to it and move on :)

• If you think creating an word skeleton on designs by section is optimal (my recommendation as first step) YET, would like for you to bring brainstorming to lead the design as you see fit, first.

Dedicated time: April 23rd to April 30 — 6 work days

Lets have fun,

[aeiras]

I am sincerely impressed with how well written this project is. Congratulations. I am finished with editing.

Thank you @mblevins65!

[rstjames]

Hello everyone,
Attached you will find the first version of the MP white paper PDF.

Design is still rough.

• Pictures are "filler" for now
• Icons will be adjusted so they are all the same style
• I will adjust text columns so that they stay aligned on all pages
• Check the content is flow ( this will be tweaked after images are added)

Content
We are right now missing images referenced in the document. When I have these items I will re-draw them in the MP style and add them to the document. But sense I do not know how all these images will look and the space they might take on a page the layouts will most likely will change a lot.

MP-Whitepaper-May22.pdf

[aeiras]

@rstjames i like every new design, specially the code with respect to each APIs added to version.
The media design is awesome, 100 with Lars, you rock!

[rstjames]

Tweet:
Now Available! @MicroProfileIO Technical White Paper, Lars Röwekamp @mobileLarson explains why NOW is the best time for developers and users to adopt the #MicroProfileAPIs when developing #Microservices. Read it http://bit.ly/mpWhitePaper
#MicroProfile #MPWhitePaper #opensource #Oss

[rstjames]

Final:
https://documentcloud.adobe.com/link/review?uri=urn%3Aaaid%3Ascds%3AUS%3A94916975-98e1-401f-8972-0f27f1abf8eb

[aeiras]

Approved: 360 design, tweet media design & adjustments to tweet description* @rstjames!

Lets launch it tomorrow-- you so rock! :)

[aeiras]

what comes next after publication?

documenting: After Ryan publish it tmw, the wiki via Mktg repo will state the steps taken to get here from volunteer arrival, to content creation, to review, to design & media push-- written logistics are meant to welcome any MicroProfiler interested on owning the fun challenge that goes into a pro-bono MP white paper in the future to know more about what it takes. :)

Media push: will be scheduled 1 per week on wednesdays until the end of the year, with at least 2 different media designs and media descriptions, that focus on different parts of the document: APIs & general. As feedback arrives on what works or not from downloads to consumption, adjustments will follow up without hesitation.

• MP APIs design
  MP general design

[aeiras]

MicroProfile White Paper Pro Bono by Lars published 8/1/19!

@mobileLarson this ticket will be closed though branding wise we will follow a few extra tasks the following week.
Sometime after you are back home and able, I would love for you and I to own the MP to MP introduction interview so that everyone can learn more about you as the author and also about what went down while you researched and help closed up this project! :) ETA end of August for that Q&A fun via written form. Check the guidelines of fun interview, the questions need to be adjusted to White Paper how we got here :) so fun!

Now-- happily closing this ticket.

[aeiras]

@mobileLarson & @rstjames,

I have created a crude draft of steps and would appreciate (without rush) that you make it better, if possible. Thanks!

How to create OSS Content Steps

[rstjames]

Hi made a couple adjustments. I will look it over again soon. Ryan

…

On Fri, Aug 2, 2019 at 9:47 PM Amelia Eiras ***@***.***> wrote: @mobileLarson <https://github.com/mobileLarson> & @rstjames <https://github.com/rstjames>, I have created a crude draft of steps and would appreciate (without rush) that you make it better, if possible. Thanks! How to create OSS Content Steps <https://github.com/eclipse/microprofile-marketing/wiki/Pro-Bono:-OSS-Content-Creation-Steps-for-White-Paper,-Case-Study,-e-Book...> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#3>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AC4R6MSWYP6ZHPDY26XTJO3QCSFOHANCNFSM4GYQK5ZA> .

-- * Ryan St. James * rstjames@tomitribe.com @s8ntjames <https://twitter.com/s8ntjames> tomitribe.com tomitribe.io

[crackitty]

Final:
https://documentcloud.adobe.com/link/review?uri=urn%3Aaaid%3Ascds%3AUS%3A94916975-98e1-401f-8972-0f27f1abf8eb

Hi,
I just read the whitepaper and found quite a few grammatical errors in it. If you like I would be happy to help out with this. Just let me know if that's something you're interested in and I'd be happy to help out. That applies to future issues also btw.

Charlie

[aeiras]

Hi @crackitty,

Charlie today and always content betterment on MP content is welcomed.
Please provide as much feedback directly in the sheet Adjustments

Once you are done, please pull me back in so that we can tackle it. Thank you for reaching out and choosing to be a formidable Contributor to the document.

[crackitty]

Hi @aeiras
I've updated that google spreadsheet with the little errors I found. Like I said, they're primarily grammatical.

It should be relatively clear what I'm indicating, I take a decent sized section of text so you know what I'm referencing first, then -> means "should be", then the corrected version. I put the corrections inside square brackets so you don't have to look too hard to see what I'm suggesting to change.

In the cases where I think something should be removed, I put it like this [-].

There was only one thing I thought you might need the original author of that section to check, since I was not 100% clear on what they meant by it. That was the second-last suggestion.

Hope this helps a little,

Charlie

[aeiras]

Charlie, yes- your time and effort will make the document better. Thank YOU!

Aside from 2 items that need extra tackling, all your suggestions are approved.
As one of the reviewers, it was efficient & much appreciated to work within 1 document, the excel sheet :)
We trace your collaboration directly in the last page of the document Charlie. Would you want your twitter or Github ID linked to it? Thanks in advance for using the sheet to add that ID.

MicroProfile is always eager to welcome anyone who do and is kind enough to reach out via open forums as you have done. Should you want to collaborate as MP wordpress editor, please check out the guidelines on how to become involved.
No pressure to join the Editors group yet I noticed your copy/edit is great, we would be lucky to have your help.

@rstjames without rush, lets see if we can have a new release for the document by the end of Oct using Charlie's feedback which I already checked. Thanks!
Also Ryan, lets add on last page of the document 23/44 part 5 after OSS Process

• Improvements After Publication: with hyperlink to the sheet.
  twitter or git of any contributor listed on the sheet whose feedback goes into the document. :)

[crackitty]

No problem at all. I'll check out the guidelines you mentioned for helping with the WP side of things too. I'd be happy to help out.

[aeiras]

@mobileLarson Hola old friend,

Would you consider participating in a Tech Talk to finally own the tracing and completion and how much work, etc went down while writing the WhitePaper?
https://www.eclipse.org/lists/jakarta.ee-community/msg01493.html
Please check out the link I have added here, if yes, own it via the forum itself and follow up the MP session media coverage.

No pressure.