<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
Hi Paul,<br>
<br>
I'll talk to Paul Gier about the best way to do this. In the
meantime, do you have a list of changes that need to be made to the
README files?<br>
<br>
Thanks,<br>
Sande<br>
<br>
<div class="moz-cite-prefix">On 09/23/2015 06:57 AM, Paul Robinson
wrote:<br>
</div>
<blockquote
cite="mid:CAL+vToaB0pe+kKo_KZibih0qFhJ+5u-p84mta2LPHWmeC7Fy=w@mail.gmail.com"
type="cite">
<div dir="ltr">
<div>I'm resurrecting this thread, as it's being discussed on: <a
moz-do-not-send="true"
href="https://issues.jboss.org/browse/RHD-722">https://issues.jboss.org/browse/RHD-722</a></div>
<div><br>
</div>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">On Wed, Jan 14, 2015 at 11:52 AM, Paul
Robinson <span dir="ltr"><<a moz-do-not-send="true"
href="mailto:paul.robinson@redhat.com" target="_blank">paul.robinson@redhat.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
<div style="word-wrap:break-word"><br>
<div>
<div>
<div class="h5">
<blockquote type="cite">
<div>On 14 Jan 2015, at 16:08, Paul Gier <<a
moz-do-not-send="true"
href="mailto:pgier@redhat.com" target="_blank">pgier@redhat.com</a>>
wrote:</div>
<br>
<div>On 01/13/2015 02:36 AM, Paul Robinson wrote:<br>
<blockquote type="cite"><br>
<blockquote type="cite">On 13 Jan 2015, at
04:27, Paul Gier <<a
moz-do-not-send="true"
href="mailto:pgier@redhat.com"
target="_blank">pgier@redhat.com</a><br>
<<a moz-do-not-send="true"
href="mailto:pgier@redhat.com"
target="_blank">mailto:pgier@redhat.com</a>>>
wrote:<br>
<br>
On 01/07/2015 08:33 AM, Sande Gilda wrote:<br>
<blockquote type="cite"><br>
On 01/07/2015 05:29 AM, Paul Robinson
wrote:<br>
<blockquote type="cite">Paul,<br>
<br>
I think you are the right person for
this, but I could be wrong…<br>
<br>
On JBoss Developer we index quickstarts
for each product and render<br>
some of the documentation (README.md,
CONTRIBUTING.md, for example) on<br>
the site. Here’s an<br>
example:<a class="moz-txt-link-freetext" href="http://">http://</a><a moz-do-not-send="true"
href="http://www.jboss.org/quickstarts/eap/contributing/"
target="_blank">www.jboss.org/quickstarts/eap/contributing/</a><br>
<<a moz-do-not-send="true"
href="http://www.jboss.org/quickstarts/eap/contributing/"
target="_blank">http://www.jboss.org/quickstarts/eap/contributing/</a>><br>
<<a moz-do-not-send="true"
href="http://www-stg.jboss.org/pr/714/build/1464/quickstarts/eap/contributing/"
target="_blank">http://www-stg.jboss.org/pr/714/build/1464/quickstarts/eap/contributing/</a>>.<br>
We index the latest release of each
quickstart from the related<br>
Quickstart repo in the JBoss Developer
GitHub organisation. It’s<br>
important that we index the release, as
we know it has been QA’d<br>
against the latest product GA on the
site.<br>
<br>
However, there are several cases where
broken links exist in the<br>
documentation that we are indexing.
Notice the ‘Fork’ link<br>
on <a moz-do-not-send="true"
href="http://www.jboss.org/quickstarts/eap/contributing/"
target="_blank">http://www.jboss.org/quickstarts/eap/contributing/</a>.
This is due to<br>
a broken link in the source<br>
content:<br>
<a moz-do-not-send="true"
href="https://github.com/jboss-developer/jboss-eap-quickstarts/blob/6.3.0.GA/CONTRIBUTING.md"
target="_blank">https://github.com/jboss-developer/jboss-eap-quickstarts/blob/6.3.0.GA/CONTRIBUTING.md</a>.<br>
This is easy to fix at source, but we
would need to wait for the next<br>
quickstarts release (in this case EAP <a
moz-do-not-send="true"
href="http://6.4.0.GA" target="_blank">6.4.0.GA</a>)
before JBoss Developer<br>
can consume the fix. Broken links are
bad for user experience and<br>
adversely affect SEO, so we’d rather get
them fixed sooner. <br>
<br>
</blockquote>
The CONTRIBUTING guide was moved to a
common location to make it easier<br>
to maintain and share across products:<br>
<a moz-do-not-send="true"
href="https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONTRIBUTING.md"
target="_blank">https://github.com/jboss-developer/jboss-developer-shared-resources/blob/master/guides/CONTRIBUTING.md</a><br>
<br>
I moved quite a few files to the common
location to make updates easier.<br>
The list is here:<br>
<a moz-do-not-send="true"
href="https://github.com/jboss-developer/jboss-developer-shared-resources/tree/master/guides"
target="_blank">https://github.com/jboss-developer/jboss-developer-shared-resources/tree/master/guides</a><br>
<br>
Since this file doesn't ship with a
product, we can update it as needed.<br>
<blockquote type="cite">One solution would
be to allow documentation only changes
to be made<br>
to quickstarts between releases. In the
example above, we would create<br>
a commit (fixing the broken link) on top
of the <a moz-do-not-send="true"
href="http://6.3.0.GA" target="_blank">6.3.0.GA</a>
release<br>
(<a moz-do-not-send="true"
href="https://github.com/jboss-developer/jboss-eap-quickstarts/releases/tag/6.3.0.GA"
target="_blank">https://github.com/jboss-developer/jboss-eap-quickstarts/releases/tag/6.3.0.GA</a>)<br>
and then tag it as a new release. I
think we’d have to use some naming<br>
convention to indicate it was just docs
that changed. JBoss Developer<br>
would then index the new tag in order to
consume the fix.<br>
</blockquote>
Should we create a new branch for these
issues, for example,<br>
6.3.1-develop and 6.3.1? Is it possible to
create a new quickstart<br>
distribution after GA?<br>
</blockquote>
<br>
It's probably up to QA and PM whether we
want to deliver an updated zip<br>
with the patch stream (6.3.x). I think we
don't do it now just because<br>
they don't want the extra effort of testing
it. I think we're pretty<br>
much free to do what we want in the git
repo, so we could create a<br>
maintenance branch, although I'm not sure
how we share that with the<br>
customers.<br>
</blockquote>
<br>
So how about we limit these changes to just
documentation (no code<br>
fixes) and only to critical items like broken
links. We make the changes<br>
in the JBoss Developer GitHub repo and consume
these changes on the<br>
JBoss Developer site.<br>
<br>
QA and PM can ship these updated QS if they
want, with the patch<br>
releases of the product.<br>
<br>
Customers can go to JBoss Developer for the
latest fixes to the QS docs.<br>
If they really want a new release, that’s gone
through QA, then they<br>
would need to take that up with whoever
manages their contract (not sure<br>
on the process for that, but hopefully you get
my point).<br>
<br>
</blockquote>
<br>
That's fine with me.<br>
</div>
</blockquote>
<div><br>
</div>
</div>
</div>
<div>Great. Does this need adding to some guidlines
somewhere?</div>
<div>
<div class="h5"><br>
<blockquote type="cite">
<div><br>
<blockquote type="cite"><br>
<blockquote type="cite"><br>
<blockquote type="cite">
<blockquote type="cite"><br>
Is this the right thing to do?<br>
<br>
Paul.<br>
<br>
-- <br>
Paul Robinson<br>
JBoss Developer Team Lead (<a
moz-do-not-send="true"
href="http://www.jboss.org"
target="_blank">www.jboss.org</a><br>
<<a moz-do-not-send="true"
href="http://www.jboss.org/"
target="_blank">http://www.jboss.org/</a>>
<<a moz-do-not-send="true"
href="http://www.jboss.org"
target="_blank">http://www.jboss.org</a>
<<a moz-do-not-send="true"
href="http://www.jboss.org/"
target="_blank">http://www.jboss.org/</a>>>)<br>
<br>
Free/busy<br>
info:<br>
<a moz-do-not-send="true"
href="https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London"
target="_blank">https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London</a><br>
<br>
JBoss, a Division of Red Hat<br>
Registered in England and Wales under
Company Registration No. 03798903<br>
Directors:Michael Cunningham (US),
Charles Peters (US), Matt Parson<br>
(US), Paul Hickey (Ireland)<br>
<br>
<br>
<br>
_______________________________________________<br>
jbossdeveloper mailing list<br>
<a moz-do-not-send="true"
href="mailto:jbossdeveloper@lists.jboss.org"
target="_blank">jbossdeveloper@lists.jboss.org</a>
<mailto:<a moz-do-not-send="true"
href="mailto:jbossdeveloper@lists.jboss.org"
target="_blank">jbossdeveloper@lists.jboss.org</a>><br>
<a moz-do-not-send="true"
href="https://lists.jboss.org/mailman/listinfo/jbossdeveloper"
target="_blank">https://lists.jboss.org/mailman/listinfo/jbossdeveloper</a><br>
</blockquote>
</blockquote>
</blockquote>
<br>
<br>
Paul.<br>
<br>
-- <br>
Paul Robinson<br>
JBoss Developer Team Lead (<a
moz-do-not-send="true"
href="http://www.jboss.org" target="_blank">www.jboss.org</a>
<<a moz-do-not-send="true"
href="http://www.jboss.org" target="_blank">http://www.jboss.org</a>>)<br>
<br>
Free/busy<br>
info: <a moz-do-not-send="true"
href="https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London"
target="_blank">https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London</a><br>
<br>
JBoss, a Division of Red Hat<br>
Registered in England and Wales under Company
Registration No. 03798903<br>
Directors:Michael Cunningham (US), Charles
Peters (US), Matt Parson<br>
(US), Paul Hickey (Ireland)<br>
<br>
</blockquote>
</div>
</blockquote>
</div>
</div>
</div>
<span class="HOEnZb"><font color="#888888"><br>
</font></span>
<div><span class="HOEnZb"><font color="#888888">
</font></span>
<div
style="text-align:start;text-indent:0px;word-wrap:break-word"><span
class="HOEnZb"><font color="#888888">
<div
style="color:rgb(0,0,0);letter-spacing:normal;text-transform:none;white-space:normal;word-spacing:0px;font-family:Helvetica;font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;line-height:normal;text-align:start;text-indent:0px;word-wrap:break-word"><br>
Paul.</div>
<div
style="color:rgb(0,0,0);letter-spacing:normal;text-transform:none;white-space:normal;word-spacing:0px;font-family:Helvetica;font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;line-height:normal;text-align:start;text-indent:0px;word-wrap:break-word"><br>
</div>
<div
style="color:rgb(0,0,0);letter-spacing:normal;text-transform:none;white-space:normal;word-spacing:0px;font-family:Helvetica;font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;line-height:normal;text-align:start;text-indent:0px;word-wrap:break-word">-- <br>
Paul Robinson</div>
<div
style="color:rgb(0,0,0);letter-spacing:normal;text-transform:none;white-space:normal;word-spacing:0px;font-family:Helvetica;font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;line-height:normal;text-align:start;text-indent:0px;word-wrap:break-word">JBoss
Developer Team Lead (<a moz-do-not-send="true"
href="http://www.jboss.org" target="_blank">www.jboss.org</a>)</div>
</font></span><span class="">
<div
style="color:rgb(0,0,0);letter-spacing:normal;text-transform:none;white-space:normal;word-spacing:0px;font-family:Helvetica;font-size:14px;font-style:normal;font-variant:normal;font-weight:normal;line-height:normal;text-align:start;text-indent:0px;word-wrap:break-word"><br>
</div>
<div
style="text-align:start;text-indent:0px;word-wrap:break-word">Free/busy
info: <a moz-do-not-send="true"
href="https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London"
target="_blank">https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London</a><br>
<br>
JBoss, a Division of Red Hat<br>
Registered in England and Wales under Company
Registration No. 03798903<br>
Directors:Michael Cunningham (US), Charles Peters
(US), Matt Parson (US), Paul Hickey (Ireland)</div>
</span></div>
</div>
<br>
</div>
<br>
_______________________________________________<br>
jbossdeveloper mailing list<br>
<a moz-do-not-send="true"
href="mailto:jbossdeveloper@lists.jboss.org">jbossdeveloper@lists.jboss.org</a><br>
<a moz-do-not-send="true"
href="https://lists.jboss.org/mailman/listinfo/jbossdeveloper"
rel="noreferrer" target="_blank">https://lists.jboss.org/mailman/listinfo/jbossdeveloper</a><br>
</blockquote>
</div>
<br>
<br clear="all">
<div><br>
</div>
-- <br>
<div class="gmail_signature">
<div dir="ltr">
<div>
<div dir="ltr">
<div>Paul</div>
<div><br>
</div>
<div>-----</div>
<div>Paul Robinson</div>
<div><a moz-do-not-send="true"
href="http://developers.redhat.com" target="_blank">developers.redhat.com</a>
Lead</div>
<div>JBoss Developer Lead (<a moz-do-not-send="true"
href="http://www.jboss.org" target="_blank">www.jboss.org</a>)</div>
<div><br>
</div>
<div>Free/busy info: <a moz-do-not-send="true"
href="https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London"
target="_blank">https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europe/London</a></div>
<div><br>
</div>
<div>JBoss, a Division of Red Hat</div>
<div>Registered in England and Wales under Company
Registration No. 03798903</div>
<div>Directors:Michael Cunningham (US), Charles Peters
(US), Matt Parson (US), Paul Hickey (Ireland)</div>
</div>
</div>
</div>
</div>
</div>
</blockquote>
<br>
</body>
</html>