accumulo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctubbsii <...@git.apache.org>
Subject [GitHub] accumulo pull request #160: ACCUMULO-4490: Simplify Accumulo scripts and con...
Date Wed, 26 Oct 2016 22:26:54 GMT
Github user ctubbsii commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/160#discussion_r85228802
  
    --- Diff: INSTALL.md ---
    @@ -26,33 +25,50 @@ source code.  Unpack as follows.
         tar xzf <some dir>/accumulo-X.Y.Z-bin.tar.gz
         cd accumulo-X.Y.Z
     
    +There are three scripts in the the `bin/` directory that are used to manage Accumulo:
    +
    +1. `accumulo` - Runs Accumulo command-line tools and starts Accumulo processes
    +2. `accumulo-service` - Runs Accumulo processes as services
    +3. `accumulo-cluster` - Manages Accumulo cluster on a single node or several nodes
    +
    +These scripts will be used in the remaining instructions to configure and run Accumulo.
    +
    +Add the following to your `~/.bashrc` if you want to be able to execute these scripts
    --- End diff --
    
    I think we can skip all the `.bashrc` instructions. This is very specific to a particular
shell, and not necessarily generally applicable. To keep the docs concise, it's better to
not try to comprehensively document tooling external to Accumulo, such as the user's shell,
unless absolutely needed.
    
    If you think it's essential to remind users of the option of adding items to their path,
perhaps it's best to keep it generic, as in "For convenience, consider adding the accumulo-X.Y.Z/bin/
directory to your shell's path." A blog post, video tutorial, the user's own shell's documentation,
or a simple Google search can help them figure out how to do that, if they need the extra
details.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message