accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [accumulo-website] branch master updated: Renamed quick-install to quickstart (#133)
Date Mon, 19 Nov 2018 17:02:44 GMT
This is an automated email from the ASF dual-hosted git repository.

mwalch pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git


The following commit(s) were added to refs/heads/master by this push:
     new f1d938d  Renamed quick-install to quickstart (#133)
f1d938d is described below

commit f1d938d28067e7ca3017db76042b5cb0d294f82b
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Mon Nov 19 12:02:39 2018 -0500

    Renamed quick-install to quickstart (#133)
    
    * Made it first page in docs
    * Updated links
---
 _docs-2/administration/in-depth-install.md                  | 4 ++--
 _docs-2/administration/upgrading.md                         | 2 +-
 _docs-2/configuration/files.md                              | 6 +++---
 _docs-2/getting-started/design.md                           | 4 ++--
 _docs-2/getting-started/features.md                         | 2 +-
 _docs-2/getting-started/{quick-install.md => quickstart.md} | 8 +++-----
 _docs-2/index.md                                            | 2 +-
 _docs-2/security/authentication.md                          | 2 +-
 _includes/nav.html                                          | 2 +-
 contributor/making-release.md                               | 6 +-----
 10 files changed, 16 insertions(+), 22 deletions(-)

diff --git a/_docs-2/administration/in-depth-install.md b/_docs-2/administration/in-depth-install.md
index e3d39bc..524edd3 100644
--- a/_docs-2/administration/in-depth-install.md
+++ b/_docs-2/administration/in-depth-install.md
@@ -5,7 +5,7 @@ order: 1
 ---
 
 This document provides detailed instructions for installing Accumulo. For basic
-instructions, see the [quick installation guide][quick].
+instructions, see the [quick start].
 
 ## Hardware
 
@@ -665,7 +665,7 @@ same version your Accumulo is built with.
 Please check the release notes for your Accumulo version or use the
 mailing lists at https://accumulo.apache.org for more info.
 
-[quick]: {% durl getting-started/quick-install %}
+[quick start]: {% durl getting-started/quickstart %}
 [monitor]: {% durl administration/monitoring-metrics#monitor %}
 [config-mgmt]: {% durl configuration/overview %}
 [instance.volumes]: {% purl instance.volumes %}
diff --git a/_docs-2/administration/upgrading.md b/_docs-2/administration/upgrading.md
index 7489e19..4ad5a00 100644
--- a/_docs-2/administration/upgrading.md
+++ b/_docs-2/administration/upgrading.md
@@ -14,7 +14,7 @@ Follow the steps below to upgrade your Accumulo instance and client to 2.0.
 
 Upgrading to Accumulo 2.0 is done by stopping Accumulo 1.8/9 and starting Accumulo 2.0.
 
-Before stopping Accumulo 1.8/9, install Accumulo 2.0 and configure it by following the [2.0
install instructions]({% durl getting-started/quick-install %}).
+Before stopping Accumulo 1.8/9, install Accumulo 2.0 and configure it by following the [2.0
quick start]({% durl getting-started/quickstart %}).
 
 There are several changes to scripts and configuration in 2.0 so be careful when using configuration
or automated setup designed for 1.8/9.
 Below are some changes in 2.0 that you should be aware of:
diff --git a/_docs-2/configuration/files.md b/_docs-2/configuration/files.md
index 820bdde..bc62910 100644
--- a/_docs-2/configuration/files.md
+++ b/_docs-2/configuration/files.md
@@ -12,7 +12,7 @@ Accumulo has the following configuration files which can be found in the
 Configures Accumulo server processes using [server properties]({% durl configuration/server-properties
%}).
 This file is needed on every host that runs Accumulo processes so any configuration should
be replicated to
 all hosts of the Accumulo cluster. If a property is not configured here, it might have been
-[configured another way]({% durl configuration/overview %}).  See the [quick install] for
help with configuring
+[configured another way]({% durl configuration/overview %}).  See the [quick start] for help
with configuring
 this file.
 
 ## accumulo-client.properties
@@ -26,7 +26,7 @@ AccumuloClient client = Accumulo.newClient()
                            .from("/path/to/accumulo-client.properties").build();
 ```
 
-See the [quick install] for help with configuring this file.
+See the [quick start] for help with configuring this file.
 
 ## accumulo-env.sh
 
@@ -83,4 +83,4 @@ to run standby Tracers that can take over if the lead Tracer fails.
 [Tablet Server]: {% durl getting-started/design#tablet-server %}
 [Monitor]: {% durl getting-started/design#monitor %}
 [Tracer]: {% durl getting-started/design#tracer %}
-[quick install]: {% durl getting-started/quick-install#configuring-accumulo %}
+[quick start]: {% durl getting-started/quickstart#configuring-accumulo %}
diff --git a/_docs-2/getting-started/design.md b/_docs-2/getting-started/design.md
index 79d433b..711783f 100644
--- a/_docs-2/getting-started/design.md
+++ b/_docs-2/getting-started/design.md
@@ -1,7 +1,7 @@
 ---
-title: Accumulo Design
+title: Design
 category: getting-started
-order: 1
+order: 2
 ---
 
 ## Background
diff --git a/_docs-2/getting-started/features.md b/_docs-2/getting-started/features.md
index 9746f2d..bf0a9ba 100644
--- a/_docs-2/getting-started/features.md
+++ b/_docs-2/getting-started/features.md
@@ -1,7 +1,7 @@
 ---
 title: Features
 category: getting-started
-order: 2
+order: 3
 redirect_from:
   - /features/
   - /notable_features/
diff --git a/_docs-2/getting-started/quick-install.md b/_docs-2/getting-started/quickstart.md
similarity index 97%
rename from _docs-2/getting-started/quick-install.md
rename to _docs-2/getting-started/quickstart.md
index 329b906..47c0146 100644
--- a/_docs-2/getting-started/quick-install.md
+++ b/_docs-2/getting-started/quickstart.md
@@ -1,12 +1,10 @@
 ---
-title: Quick Installation
+title: Quick Start
 category: getting-started
-order: 3
+order: 1
 ---
 
-<!-- IMPORTANT: This file should mirror (with minor differences) INSTALL.md in the Accumulo
repo -->
-
-This document provides basic instructions for installing Accumulo. For detailed instructions,
+This quick start provides basic instructions for installing and running Accumulo. For detailed
instructions,
 see the [in-depth installation guide][in-depth].
 
 Either [download] or [build] a binary distribution of Accumulo from source code and
diff --git a/_docs-2/index.md b/_docs-2/index.md
index 51de7fa..d7ad95f 100644
--- a/_docs-2/index.md
+++ b/_docs-2/index.md
@@ -1,4 +1,4 @@
 ---
 title: Apache Accumulo Documentation
-redirect_to: /docs/2.x/getting-started/design
+redirect_to: /docs/2.x/getting-started/quickstart
 ---
diff --git a/_docs-2/security/authentication.md b/_docs-2/security/authentication.md
index 549c031..7f3051d 100644
--- a/_docs-2/security/authentication.md
+++ b/_docs-2/security/authentication.md
@@ -19,7 +19,7 @@ All authentication methods implement [Authenticator]. The default (password-base
 
 ## Root user
 
-When [Accumulo is initialized]({% durl getting-started/quick-install#initialization %}),
a `root` user is created and given
+When [Accumulo is initialized]({% durl getting-started/quickstart#initialization %}), a `root`
user is created and given
 a password.  This `root` user is used to create other users. 
 
 ## Creating users
diff --git a/_includes/nav.html b/_includes/nav.html
index 41549d6..3f8fc51 100644
--- a/_includes/nav.html
+++ b/_includes/nav.html
@@ -25,7 +25,7 @@
         <li class="dropdown">
           <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation<span
class="caret"></span></a>
           <ul class="dropdown-menu">
-            <li><a href="{{ site.docs_baseurl }}/getting-started/design">User
Manual (2.x)</a></li>
+            <li><a href="{{ site.docs_baseurl }}/getting-started/quickstart">User
Manual (2.x)</a></li>
             <li><a href="{{ site.baseurl }}/quickstart-1.x">Quickstart (1.x)</a></li>
             <li><a href="{{ site.baseurl }}/{{ site.latest_minor_release }}/accumulo_user_manual.html">User
Manual ({{ site.latest_minor_release }})</a></li>
             <li><a href="{{ site.baseurl }}/{{ site.latest_minor_release }}/apidocs">Javadocs
({{ site.latest_minor_release }})</a></li>
diff --git a/contributor/making-release.md b/contributor/making-release.md
index aa0de6b..d895fa7 100644
--- a/contributor/making-release.md
+++ b/contributor/making-release.md
@@ -131,11 +131,7 @@ After a successful vote, [this website][website-repo] needs to be updated
with t
 Starting with 2.0.0, the source code for the Accumulo documentation was moved to the [accumulo-website
repo][website-repo] except
 for two markdown files that should be changed in the Accumulo repo and copied/mirrored to
the website repo for releases.
 
-1. `INSTALL.md` is mirrored from Accumulo repo using a diff tool like `meld` or `vimdiff`.
-
-        meld /path/to/accumulo/INSTALL.md /path/to/accumulo-website/_docs-2-x/getting-started/quick-install.md
-
-2. `server-properties.md` and `client-properties.md` should be copied after it is generated
by the Accumulo build.
+1. `server-properties.md` and `client-properties.md` should be copied after it is generated
by the Accumulo build.
 
         cp /path/to/accumulo/core/target/generated-docs/*-properties.md /path/to/accumulo-website/_docs-2-x/configuration/
 


Mime
View raw message