activemq-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Ian Brandt (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (AMQ-5232) Version documentation with releases for better SEO
Date Wed, 18 Jun 2014 18:54:24 GMT

     [ https://issues.apache.org/jira/browse/AMQ-5232?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Ian Brandt updated AMQ-5232:
----------------------------

    Description: 
More than a few times a web search has pointed me to ActiveMQ documentation that was not obviously
for an older version.  AMQ-5230 reflects just such a case.

I've always liked how the [Confluence documentation|https://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home]
has a banner at the top of each page which clearly states the version of the software the
page is for, and gives links to other versions.  They document how to do this [using a Space
per version|https://confluence.atlassian.com/display/DOC/Managing+the+Life+Cycle+of+your+Technical+Documentation#ManagingtheLifeCycleofyourTechnicalDocumentation-Releasemanagement],
and [Documentation Themes for the banner|https://confluence.atlassian.com/display/CONFKB/How+to+Display+a+Banner+Like+the+Confluence+Documentation+Space].

I believe SEO for the ActiveMQ documentation would be improved if URLs such as http://activemq.apache.org/initial-configuration.html
consistently documented the latest GA version, with a clear version marker and links to earlier
documentation.

I'm not sure how https://cwiki.apache.org/confluence/display/ACTIVEMQ is exported to http://activemq.apache.org/.
 Perhaps the Space-per-version scheme wouldn't be compatible with this machinery?

  was:
More than a few times a web search has pointed me to ActiveMQ documentation that was not obviously
for an older version.  AMQ-5230 reflects just such a case.

I've always liked how the [Confluence documentation|https://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home]
has a banner at the top of each page which clearly states the version of the software the
page is for, and gives links to other versions.  They document how to do this [using Spaces
per version|https://confluence.atlassian.com/display/DOC/Managing+the+Life+Cycle+of+your+Technical+Documentation#ManagingtheLifeCycleofyourTechnicalDocumentation-Releasemanagement],
and [Documentation Themes for the banner|https://confluence.atlassian.com/display/CONFKB/How+to+Display+a+Banner+Like+the+Confluence+Documentation+Space].

I believe SEO for the ActiveMQ documentation would be improved if URLs such as http://activemq.apache.org/initial-configuration.html
consistently documented the latest GA version, with a clear version marker and links to earlier
documentation.

I'm not sure how https://cwiki.apache.org/confluence/display/ACTIVEMQ is exported to http://activemq.apache.org/.
 Perhaps the Space-per-version scheme wouldn't be compatible with this machinery?


> Version documentation with releases for better SEO
> --------------------------------------------------
>
>                 Key: AMQ-5232
>                 URL: https://issues.apache.org/jira/browse/AMQ-5232
>             Project: ActiveMQ
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Ian Brandt
>            Priority: Minor
>
> More than a few times a web search has pointed me to ActiveMQ documentation that was
not obviously for an older version.  AMQ-5230 reflects just such a case.
> I've always liked how the [Confluence documentation|https://confluence.atlassian.com/display/DOC/Confluence+Documentation+Home]
has a banner at the top of each page which clearly states the version of the software the
page is for, and gives links to other versions.  They document how to do this [using a Space
per version|https://confluence.atlassian.com/display/DOC/Managing+the+Life+Cycle+of+your+Technical+Documentation#ManagingtheLifeCycleofyourTechnicalDocumentation-Releasemanagement],
and [Documentation Themes for the banner|https://confluence.atlassian.com/display/CONFKB/How+to+Display+a+Banner+Like+the+Confluence+Documentation+Space].
> I believe SEO for the ActiveMQ documentation would be improved if URLs such as http://activemq.apache.org/initial-configuration.html
consistently documented the latest GA version, with a clear version marker and links to earlier
documentation.
> I'm not sure how https://cwiki.apache.org/confluence/display/ACTIVEMQ is exported to
http://activemq.apache.org/.  Perhaps the Space-per-version scheme wouldn't be compatible
with this machinery?



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message