misc minor changes to windup eclipse blog post - #1
Open
d-s wants to merge 2 commits into
Open
Conversation
johnsteele
force-pushed
the
master
branch
13 times, most recently
from
February 21, 2017 15:17
c64e0d0 to
d87fcc2
Compare
johnsteele
force-pushed
the
master
branch
14 times, most recently
from
December 15, 2017 23:06
6675a93 to
cd1f04f
Compare
johnsteele
force-pushed
the
master
branch
9 times, most recently
from
December 18, 2017 18:15
ced31ee to
5e9bd51
Compare
johnsteele
force-pushed
the
master
branch
5 times, most recently
from
January 10, 2018 05:44
b40b0b1 to
577f843
Compare
johnsteele
force-pushed
the
master
branch
4 times, most recently
from
July 5, 2018 23:08
38607fc to
d90e42c
Compare
johnsteele
force-pushed
the
master
branch
4 times, most recently
from
July 18, 2018 11:52
91af4eb to
d0b5715
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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