Updating quickstarts documentation between releases
by Paul Robinson
Paul,
I think you are the right person for this, but I could be wrong…
On JBoss Developer we index quickstarts for each product and render some of the documentation (README.md, CONTRIBUTING.md, for example) on the site. Here’s an example:http://www.jboss.org/quickstarts/eap/contributing/ <http://www-stg.jboss.org/pr/714/build/1464/quickstarts/eap/contributing/>. We index the latest release of each quickstart from the related Quickstart repo in the JBoss Developer GitHub organisation. It’s important that we index the release, as we know it has been QA’d against the latest product GA on the site.
However, there are several cases where broken links exist in the documentation that we are indexing. Notice the ‘Fork’ link on http://www.jboss.org/quickstarts/eap/contributing/ <http://www.jboss.org/quickstarts/eap/contributing/>. This is due to a broken link in the source content: https://github.com/jboss-developer/jboss-eap-quickstarts/blob/6.3.0.GA/CO... <https://github.com/jboss-developer/jboss-eap-quickstarts/blob/6.3.0.GA/CO...>. This is easy to fix at source, but we would need to wait for the next quickstarts release (in this case EAP 6.4.0.GA) before JBoss Developer can consume the fix. Broken links are bad for user experience and adversely affect SEO, so we’d rather get them fixed sooner.
One solution would be to allow documentation only changes to be made to quickstarts between releases. In the example above, we would create a commit (fixing the broken link) on top of the 6.3.0.GA release (https://github.com/jboss-developer/jboss-eap-quickstarts/releases/tag/6.3... <https://github.com/jboss-developer/jboss-eap-quickstarts/releases/tag/6.3...>) and then tag it as a new release. I think we’d have to use some naming convention to indicate it was just docs that changed. JBoss Developer would then index the new tag in order to consume the fix.
Is this the right thing to do?
Paul.
--
Paul Robinson
JBoss Developer Team Lead (www.jboss.org)
Free/busy info: https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europ...
JBoss, a Division of Red Hat
Registered in England and Wales under Company Registration No. 03798903
Directors:Michael Cunningham (US), Charles Peters (US), Matt Parson (US), Paul Hickey (Ireland)
8 years, 7 months
<repository /> definition in pom.xml for Quickstarts and Demos
by Rafael Benevides
Hi all,
I was thinking about the implementation of the repository definition in
pom.xml and I want to share my thoughts:
- Create a QSTools CHECKER to mark the lack of <repository /> as a
guideline violation if MavenCentralChecker is disabled.
- The violation message will instruct to use the new QSTools GOAL
that will be created
- Create another QSTools GOAL to setup the repositories.
- There will be a list of approved repositories and its IDs (redhat
techpreview, earlyacess, jboss developer temporary, etc)
- QSTools will remove all previous repositories from pom.xml and
prompt which repositories should be added.
- This will help Quickstarts and demos to be easily buildable from
development and production branches and will also allow this list to be
bulk updated to remove any previous development repository definition.
Please,
If you have any feedback on this, feel free to reply.
--
*Rafael Benevides | Senior Software Engineer*
JBoss Developer
M: +55-61-9269-6576
Red Hat
Better technology. Faster innovation. Powered by community collaboration.
See how it works at www.redhat.com <http://www.redhat.com/>
LinkedIn <http://www.linkedin.com/company/3258288> Youtube
<https://www.youtube.com/redhatlatam>
8 years, 11 months
jboss.org download of JBoss EAP 6.4 beta
by Sande Gilda
I have a documentation bug on my queue related to the green 'Download'
button on the https://www.jboss.org/products/eap/overview page.
Will that link be updated to point to the JBoss EAP 6.4 beta when it
ships, or would they have to choose 'Download JBoss EAP' to download the
beta?
I assume it will definitely be updated to JBoss EAP 6.4 GA when it ships?
Thanks,
Sande
9 years, 2 months
JBoss Developer production builds down over holiday period
by Paul Robinson
All,
Given that most of us are away for the next two weeks, we thought it best not to rebuild+publish the JBoss Developer production site every 6 hours, like we currently do. Should something go wrong it is unlikely that we would notice, plus I don’t really want to be on-call to fix it ;-)
I’ll re-enable on January the 5th.
Paul.
--
Paul Robinson
JBoss Developer Team Lead (www.jboss.org)
Free/busy info: https://www.google.com/calendar/embed?src=probinso%40redhat.com&ctz=Europ...
JBoss, a Division of Red Hat
Registered in England and Wales under Company Registration No. 03798903
Directors:Michael Cunningham (US), Charles Peters (US), Matt Parson (US), Paul Hickey (Ireland)
9 years, 3 months
