You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by mm...@apache.org on 2021/02/08 18:45:25 UTC
[accumulo-website] branch main updated: Make 2.x manual landing
page more clear (#262)
This is an automated email from the ASF dual-hosted git repository.
mmiller pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo-website.git
The following commit(s) were added to refs/heads/main by this push:
new ca97fed Make 2.x manual landing page more clear (#262)
ca97fed is described below
commit ca97fedba96f631611789bf3378754b152d73d6a
Author: Mike Miller <mm...@apache.org>
AuthorDate: Mon Feb 8 13:45:17 2021 -0500
Make 2.x manual landing page more clear (#262)
* Modify quickstart.md to have a title for the whole 2.x manual
* Add skip_doc_h1 tag to drop the title as the first header so it
can be different than the navigation link
---
_docs-2/getting-started/quickstart.md | 20 ++++++++++++++------
_layouts/docs-2.html | 2 ++
2 files changed, 16 insertions(+), 6 deletions(-)
diff --git a/_docs-2/getting-started/quickstart.md b/_docs-2/getting-started/quickstart.md
index db324ab..0fd44db 100644
--- a/_docs-2/getting-started/quickstart.md
+++ b/_docs-2/getting-started/quickstart.md
@@ -1,22 +1,29 @@
---
-title: Quick Start
+title: Setup
category: getting-started
order: 1
+skip_doc_h1: true
---
+# User Manual (2.x)
-This quick start provides basic instructions for installing and running Accumulo. For detailed instructions,
-see the [in-depth installation guide][in-depth].
+Starting with Accumulo 2.0, the user manual now lives on the website as a series of web pages. Previously, it was one large
+pdf document that was only generated during a release. The user manual can now be updated very quickly and indexed
+for searching across many webpages.
-## Consider using automated tools
+The manual can now be
+searched using the [Search link][search] at the top of the website or navigated by clicking the links to the left. If you are new
+to Accumulo, follow the instructions below to get started. For detailed instructions, see the [in-depth installation guide][in-depth].
+
+## Setup for testing or development
If you are setting up Accumulo for **testing or development,** consider using the following tools:
* [Uno] sets up Accumulo on a single machine for development
* [Muchos] sets up Accumulo on a cluster (optionally launched in Amazon EC2 and Microsoft Azure VM)
-If you are setting up Accumulo for a **production** environment, follow the instructions in this quick start.
+If you are setting up Accumulo for a **production** environment, follow the instructions below.
-## Install Accumulo
+## Setup for Production
Either [download] or [build] a binary distribution of Accumulo from source code and
unpack as follows.
@@ -200,6 +207,7 @@ When finished, use the following commands to stop Accumulo:
* Stop Accumulo service: `accumulo-service tserver stop`
* Stop Accumulo cluster: `accumulo-cluster stop`
+[search]: {{ site.baseurl }}/search
[in-depth]: {% durl administration/in-depth-install %}
[download]: {{ site.baseurl }}/downloads
[build]: https://github.com/apache/accumulo/blob/main/README.md#building
diff --git a/_layouts/docs-2.html b/_layouts/docs-2.html
index 5c10475..262d568 100644
--- a/_layouts/docs-2.html
+++ b/_layouts/docs-2.html
@@ -38,10 +38,12 @@ skiph1fortitle: true
<p>Accumulo {{ page.version }} Documentation >> {{ page.category | capitalize | replace: "-", " " }} >> {{ page.title }}</p>
{% endif %}
+ {% unless page.skip_doc_h1 %}
<div class="row">
<div class="col-md-10"><h1>{{ page.title }}</h1></div>
<div class="col-md-2"><a class="pull-right" style="margin-top: 25px;" href="https://github.com/apache/accumulo-website/edit/main/{{ page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit this page</small></a></div>
</div>
+ {% endunless %}
{{ content }}