accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Josh Elser (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-2778) Remove version specific content from example READMEs
Date Mon, 06 Apr 2015 02:12:12 GMT

    [ https://issues.apache.org/jira/browse/ACCUMULO-2778?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14459567#comment-14459567
] 

Josh Elser commented on ACCUMULO-2778:
--------------------------------------

bq. I'm not sure the version number gives the impression of unmaintained docs

That was, and still is, my impression. If I see a documentation which is supposed to be for
a specific version but then see a bunch of reference to older version, it gives me the impression
of unmaintained docs.

> Remove version specific content from example READMEs
> ----------------------------------------------------
>
>                 Key: ACCUMULO-2778
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-2778
>             Project: Accumulo
>          Issue Type: Task
>          Components: docs
>            Reporter: Josh Elser
>            Priority: Trivial
>              Labels: newbie
>             Fix For: 1.8.0
>
>
> The example READMEs {{docs/examples*}} have a bunch of references to the specific version
they were run against, for example the Accumulo version via some shell output or the version
in the instance name.
> We should remove version specifics from the readmes so that it's less to maintain when
we release a new number and doesn't give the impression of unmaintained docs.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message