[ https://issues.jboss.org/browse/JBDS-2456?page=com.atlassian.jira.plugin.... ] Michelle Murray commented on JBDS-2456: --------------------------------------- Love the pom.xml - very succinct, just info about building, and then directing user to README.md for more info. README.md looks good and you've made the product name change to 'Red Hat JBDS' - you only *have* to use the full name the first time you use it (so first line of doc here) but if you want to use it in more places that's fine. A few minor and picky :) suggestions: * Typo = Red Hat JBoss Developer Studio uses a Central Discovery plugin which is *built* here * '## Related projects' - is this the best title for this section? Are these things components of the productized version? Perhaps '## Components of RH JBDS' would be better? * '## Related projects' states 'RH JBDS uses blah which is built here' - would it be more accurate to say 'built from the source code here' or 'whose source code is located here'? * '## Download An Installer Jar Or Update Site Zip' - other titles have capitalized first letter of first word and then only capitalize product name. Consider changing to '## Download an installer jar or update site zip'. * Why do some RH JBDS have _ _ before and after the product name? It's fine that they do. It seems to be that titles don't and body text do, but body text in '## Related projects' goes against this. Should change to '_Red Hat JBoss Developer Studio_ uses a parent pom ...' etc. for consistency. * Should split info in '## Install RH JBDS', putting info about updating into an '## Updating RH JBDS' section. Is update site to do with initial install or updating? BYOE would probably go under install section. If not putting them into separate sections, then need to make it clear when user (inc. me ;)) needs to use update site - during install? * Typo = Or, to install the "Bring Your Own Eclipse" ... Help > Install from the generated site in site/target/repository/ (or the installer jar, as noted above*)* * '## Contribute fixes and features' has line breaks mid sentence unlike rest of document text. So 'want to participate', 'an issue in the' and 'browse/JBDS) describing' * Typo for professional doc = After *you are* happy with your changes Thanks [~nickboldt]. -- This message is automatically generated by JIRA. If you think it was sent incorrectly, please contact your JIRA administrators For more information on JIRA, see: http://www.atlassian.com/software/jira