[jdf-dev] [JBoss JIRA] (JDF-127) Getting started documentation are not in sync
[
https://issues.jboss.org/browse/JDF-127?page=com.atlassian.jira.plugin.sy...
]
Hardy Ferentschik commented on JDF-127:
---------------------------------------
{quote}
Because the Building and Running on OpenShift bits do not seem out of sync.
{quote}
Not sure yet, I have not progressed so far
{quote}
Given the scenario when the repository is forked by the user, having the readme file is a
must in order for it being consistent with the other example we provide.
{quote}
+1. Even more important to have the instructions work from a virgin install of
maven/forge. If you advertise "clone me and run", then the readme needs to
work.
Getting started documentation are not in sync
---------------------------------------------
Key: JDF-127
URL: https://issues.jboss.org/browse/JDF-127
Project: JBoss Developer Framework
Issue Type: Feature Request
Components: ticket-monster
Environment: java version "1.6.0_35"
JBoss Forge, version [ 1.1.1.Final ] - JBoss, by Red Hat, Inc. [ http://jboss.org/forge
]
Reporter: Hardy Ferentschik
Assignee: Marius Bogoevici
The getting started
[readme|https://github.com/jboss-jdf/ticket-monster/blob/master/demo/READM...] is not in
sync with the [tutorial|
http://www.jboss.org/jdf/examples/ticket-monster/tutorial/AdminJSF/#_sett...].
For example the readme does not cover things like the
forge richfaces plugin installation.
One solution is to remove the step by step guide from the readme and just refer to the
tutorial. On the other hand, it is nice to have this guide in the readme, since the idea
is that people can just fork the repo, follow the readme and have the app running.
It is also important that the readme (and tutorial) assume a installation from scratch
(see also JDF-6 and JDF-126)
--
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