Skip to content

misc minor changes to windup eclipse blog post - #1

Open
d-s wants to merge 2 commits into
johnsteele:masterfrom
d-s:windup-eclipse-blog-suggestions
Open

misc minor changes to windup eclipse blog post#1
d-s wants to merge 2 commits into
johnsteele:masterfrom
d-s:windup-eclipse-blog-suggestions

Conversation

@d-s

@d-s d-s commented Feb 17, 2017

Copy link
Copy Markdown

I made a few pretty minor changes in the PR:

-- Some grammar/spelling nits.
-- Changed "--target eap" to "--target eap:7" in CLI example, in line with our recommended usage since 2.7.
-- Update site link: best to print the URL, I think. This URL wants to be copied and pasted into the Eclipse installation dialog rather than clicked through to.

I had some slightly larger changes I would suggest but didn't make in the PR. They're somewhat open-ended so I'll let you decide how to handle them if you want to make any changes:

-- Discussing the HTML reports: they really do aim not just to analyze the migration effort, but to provide assistance with solving the individual problems. In the first paragraph on the topic ("The output of running...") I might mention that. In the second paragraph, rather than saying the HTML report is not very useful for the engineer making changes (which it may or may not be, but it at least wants to be) I would highlight the advantages of the Eclipse plugin compared to the HTML reports, rather than presenting it as the reports being lousy. Maybe something like "For the engineer responsible for making changes in the code, having that information within the IDE rather than having to glance back and forth at a separate report would make things a lot more convenient."
-- The "As previously mentioned... an HTML report," can probably be clipped with no loss of understanding -- the previous mention is in the immediately preceding paragraph.
-- Rather than title the features discussion section "Windup Perspective" and organize it around the perspective, it might make sense to title it something like "Plugin Features" and then lead off with the Run Configuration information (right after showing the perspective, before Issue Explorer) rather than display that part last. That way the information is laid out in an order that matches the analysis workflow -- after all the user has to run analysis before there's any interesting information in the other views.
-- Some of the images are kind of huge. They may need to be that way to be clearly readable, but it has the effect of taking up a lot of vertical space, which makes the reader hunt for the paragraph text a little bit. Could perhaps display smaller versions of the images inline in the blog and make them clickable links to the full-size images or something. Or maybe just add more vertical space between the screenshot and text.

Feel free to pick and choose whichever suggestions you like and ignore the rest. The post looks great.

Dan

@johnsteele
johnsteele force-pushed the master branch 13 times, most recently from c64e0d0 to d87fcc2 Compare February 21, 2017 15:17
johnsteele pushed a commit that referenced this pull request Dec 5, 2017
@johnsteele
johnsteele force-pushed the master branch 14 times, most recently from 6675a93 to cd1f04f Compare December 15, 2017 23:06
@johnsteele
johnsteele force-pushed the master branch 9 times, most recently from ced31ee to 5e9bd51 Compare December 18, 2017 18:15
@johnsteele
johnsteele force-pushed the master branch 5 times, most recently from b40b0b1 to 577f843 Compare January 10, 2018 05:44
@johnsteele
johnsteele force-pushed the master branch 4 times, most recently from 38607fc to d90e42c Compare July 5, 2018 23:08
@johnsteele
johnsteele force-pushed the master branch 4 times, most recently from 91af4eb to d0b5715 Compare July 18, 2018 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant