accumulo-notifications mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "ASF GitHub Bot (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACCUMULO-4189) Add direct links in README to documentation (User Manual & Examples) on website
Date Thu, 21 Apr 2016 14:42:25 GMT

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

ASF GitHub Bot commented on ACCUMULO-4189:
------------------------------------------

Github user mikewalch commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/92#discussion_r60592421
  
    --- Diff: README.md ---
    @@ -101,14 +97,19 @@ The Accumulo project maintains binary compatibility across this API
within a
     major release, as defined in the Java Language Specification 3rd ed. Starting
     with Accumulo 1.6.2 and 1.7.0 all API changes will follow [semver 2.0][12]
     
    -[1]: http://accumulo.apache.org
    +[1]: https://accumulo.apache.org
     [2]: INSTALL.md
     [3]: TESTING.md
     [4]: http://research.google.com/archive/bigtable.html
     [5]: http://hadoop.apache.org
     [6]: http://zookeeper.apache.org
     [7]: http://thrift.apache.org/
    -[8]: http://accumulo.apache.org/notable_features.html
    +[8]: https://accumulo.apache.org/notable_features.html
     [9]: http://maven.apache.org/
    +[10]: https://accumulo.apache.org/user-manual/latest/
    +[11]: https://accumulo.apache.org/examples/latest/
    --- End diff --
    
    Removed trailing whitespace in b3aad3d96


> Add direct links in README to documentation (User Manual & Examples) on website
> -------------------------------------------------------------------------------
>
>                 Key: ACCUMULO-4189
>                 URL: https://issues.apache.org/jira/browse/ACCUMULO-4189
>             Project: Accumulo
>          Issue Type: Task
>          Components: docs, website
>            Reporter: Mike Walch
>            Assignee: Mike Walch
>            Priority: Trivial
>             Fix For: 1.8.0
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> The README currently lists the User Manual and Examples as documentation but there are
no direct links to them.  Instead, it tells users that they are available on the website.
 This is probably to limit a direct link to an older stable version in the README. It would
be better if there were direct links to a User Manual and Examples pages (which will need
to be created) that contained links to docs for all released versions.



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

Mime
View raw message