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 Developer Materials Jira Reorg
by Rafael Benevides
Hi all,
Today I started a cleanup on JDF Jira (
https://issues.jboss.org/browse/JDF ).
All unresolved issues were reviewed and most of them were reassigned or
closed (51 issues). If a Jira was assigned to you, please make sure that
it still valid or close it otherwise. Thanks Sande for helping me
closing some very old issues.
Some other issues related to jboss.org (JBossDeveloper) were moved to
https://issues.jboss.org/browse/DEVELOPER
Actually JBoss Developer Materials should be used to track Quickstarts,
Archetypes, Stacks (file and client), Ticket-Monster and QSTools. I've
created new versions that represents its components version. Examples:
quickstarts-eap-6.4.x, ticket-monster-2.6.x, ticket-monster-2.7.x. That
way we can identify which version is causing the issue and when it will
be fixed (hopefully on next version :D ).
This cleanup will ease to track each bug and feature request and place
them at the right hands and roadmap.
Thanks
--
*Rafael Benevides | Senior Software Engineer*
JBoss Developer
M: +1-919-592-6255
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>
9 years, 1 month