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: Simplified documentation (#25)
Date Fri, 22 Sep 2017 16:00:01 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 dc73330  Simplified documentation (#25)
dc73330 is described below

commit dc73330af05c462fd3dfb843282ca5f50805eebb
Author: Mike Walch <mwalch@apache.org>
AuthorDate: Fri Sep 22 11:59:59 2017 -0400

    Simplified documentation (#25)
    
    * Converted docs-unreleased collection to docs-2.0
    * Documentation is now viewble at /docs/2.0/
---
 _config.yml                                        | 28 +++++-----------------
 .../administration/configuration-management.md     |  0
 .../administration/configuration-properties.md     |  0
 .../administration/fate.md                         |  0
 .../administration/in-depth-install.md             |  0
 .../administration/kerberos.md                     |  0
 .../administration/monitoring-metrics.md           |  0
 .../administration/multivolume.md                  |  0
 .../administration/replication.md                  |  0
 .../administration/ssl.md                          |  0
 .../administration/tracing.md                      |  0
 .../development/development_tools.md               |  0
 .../development/high_speed_ingest.md               |  0
 .../development/iterators.md                       |  0
 .../development/mapreduce.md                       |  0
 .../development/proxy.md                           |  0
 .../development/sampling.md                        |  0
 .../development/security.md                        |  0
 .../development/summaries.md                       |  0
 .../getting-started/clients.md                     |  0
 .../getting-started/design.md                      |  0
 .../getting-started/quick-install.md               |  0
 .../getting-started/shell.md                       |  0
 .../getting-started/table_configuration.md         |  0
 .../getting-started/table_design.md                |  0
 {_docs-unreleased => _docs-2-0}/index.md           |  0
 .../troubleshooting/advanced.md                    |  0
 .../troubleshooting/basic.md                       |  0
 .../troubleshooting/system-metadata-tables.md      |  0
 .../troubleshooting/tools.md                       |  0
 _layouts/{docs-unreleased.html => docs-2.0.html}   |  2 +-
 ...17-06-29-accumulo-documentation-improvements.md |  9 ++++---
 contributor/making-release.md                      | 13 +++++-----
 33 files changed, 18 insertions(+), 34 deletions(-)

diff --git a/_config.yml b/_config.yml
index ba4e972..bcad220 100644
--- a/_config.yml
+++ b/_config.yml
@@ -23,12 +23,9 @@ markdown: kramdown
 
 # Collection names cannot contain periods
 collections: 
-  docs-unreleased:
+  docs-2-0:
     output: true
-    permalink: "/docs/unreleased/:path"
-#  docs-2-0:
-#    output: true
-#    permalink: "/docs/2.0/:path"
+    permalink: "/docs/2.0/:path"
 
 defaults:
   -
@@ -55,29 +52,16 @@ defaults:
   -
     scope:
       path: ""
-      type: "docs-unreleased"
+      type: "docs-2-0"
     values:
-      layout: "docs-unreleased"
+      layout: "docs-2.0"
       title_prefix: "Accumulo Documentation - "
-      version: "unreleased"
+      version: "2.0"
       latest_release: "2.0.0"
-      docs_baseurl: "/docs/unreleased"
+      docs_baseurl: "/docs/2.0"
       javadoc_base: "https://static.javadoc.io/org.apache.accumulo"
       javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.8.1"
       skiph1fortitle: "true"
-#  -
-#    scope:
-#      path: ""
-#      type: "docs-2-0"
-#    values:
-#      layout: "docs-2.0"
-#      title_prefix: "Accumulo Documentation - "
-#      version: "2.0"
-#      latest_release: "2.0.0"
-#      docs_baseurl: "/docs/2.0"
-#      javadoc_base: "https://static.javadoc.io/org.apache.accumulo"
-#      javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/2.0.0"
-#      skiph1fortitle: "true"
 
 whitelist: [jekyll-redirect-from]
 plugins: [jekyll-redirect-from]
diff --git a/_docs-unreleased/administration/configuration-management.md b/_docs-2-0/administration/configuration-management.md
similarity index 100%
rename from _docs-unreleased/administration/configuration-management.md
rename to _docs-2-0/administration/configuration-management.md
diff --git a/_docs-unreleased/administration/configuration-properties.md b/_docs-2-0/administration/configuration-properties.md
similarity index 100%
rename from _docs-unreleased/administration/configuration-properties.md
rename to _docs-2-0/administration/configuration-properties.md
diff --git a/_docs-unreleased/administration/fate.md b/_docs-2-0/administration/fate.md
similarity index 100%
rename from _docs-unreleased/administration/fate.md
rename to _docs-2-0/administration/fate.md
diff --git a/_docs-unreleased/administration/in-depth-install.md b/_docs-2-0/administration/in-depth-install.md
similarity index 100%
rename from _docs-unreleased/administration/in-depth-install.md
rename to _docs-2-0/administration/in-depth-install.md
diff --git a/_docs-unreleased/administration/kerberos.md b/_docs-2-0/administration/kerberos.md
similarity index 100%
rename from _docs-unreleased/administration/kerberos.md
rename to _docs-2-0/administration/kerberos.md
diff --git a/_docs-unreleased/administration/monitoring-metrics.md b/_docs-2-0/administration/monitoring-metrics.md
similarity index 100%
rename from _docs-unreleased/administration/monitoring-metrics.md
rename to _docs-2-0/administration/monitoring-metrics.md
diff --git a/_docs-unreleased/administration/multivolume.md b/_docs-2-0/administration/multivolume.md
similarity index 100%
rename from _docs-unreleased/administration/multivolume.md
rename to _docs-2-0/administration/multivolume.md
diff --git a/_docs-unreleased/administration/replication.md b/_docs-2-0/administration/replication.md
similarity index 100%
rename from _docs-unreleased/administration/replication.md
rename to _docs-2-0/administration/replication.md
diff --git a/_docs-unreleased/administration/ssl.md b/_docs-2-0/administration/ssl.md
similarity index 100%
rename from _docs-unreleased/administration/ssl.md
rename to _docs-2-0/administration/ssl.md
diff --git a/_docs-unreleased/administration/tracing.md b/_docs-2-0/administration/tracing.md
similarity index 100%
rename from _docs-unreleased/administration/tracing.md
rename to _docs-2-0/administration/tracing.md
diff --git a/_docs-unreleased/development/development_tools.md b/_docs-2-0/development/development_tools.md
similarity index 100%
rename from _docs-unreleased/development/development_tools.md
rename to _docs-2-0/development/development_tools.md
diff --git a/_docs-unreleased/development/high_speed_ingest.md b/_docs-2-0/development/high_speed_ingest.md
similarity index 100%
rename from _docs-unreleased/development/high_speed_ingest.md
rename to _docs-2-0/development/high_speed_ingest.md
diff --git a/_docs-unreleased/development/iterators.md b/_docs-2-0/development/iterators.md
similarity index 100%
rename from _docs-unreleased/development/iterators.md
rename to _docs-2-0/development/iterators.md
diff --git a/_docs-unreleased/development/mapreduce.md b/_docs-2-0/development/mapreduce.md
similarity index 100%
rename from _docs-unreleased/development/mapreduce.md
rename to _docs-2-0/development/mapreduce.md
diff --git a/_docs-unreleased/development/proxy.md b/_docs-2-0/development/proxy.md
similarity index 100%
rename from _docs-unreleased/development/proxy.md
rename to _docs-2-0/development/proxy.md
diff --git a/_docs-unreleased/development/sampling.md b/_docs-2-0/development/sampling.md
similarity index 100%
rename from _docs-unreleased/development/sampling.md
rename to _docs-2-0/development/sampling.md
diff --git a/_docs-unreleased/development/security.md b/_docs-2-0/development/security.md
similarity index 100%
rename from _docs-unreleased/development/security.md
rename to _docs-2-0/development/security.md
diff --git a/_docs-unreleased/development/summaries.md b/_docs-2-0/development/summaries.md
similarity index 100%
rename from _docs-unreleased/development/summaries.md
rename to _docs-2-0/development/summaries.md
diff --git a/_docs-unreleased/getting-started/clients.md b/_docs-2-0/getting-started/clients.md
similarity index 100%
rename from _docs-unreleased/getting-started/clients.md
rename to _docs-2-0/getting-started/clients.md
diff --git a/_docs-unreleased/getting-started/design.md b/_docs-2-0/getting-started/design.md
similarity index 100%
rename from _docs-unreleased/getting-started/design.md
rename to _docs-2-0/getting-started/design.md
diff --git a/_docs-unreleased/getting-started/quick-install.md b/_docs-2-0/getting-started/quick-install.md
similarity index 100%
rename from _docs-unreleased/getting-started/quick-install.md
rename to _docs-2-0/getting-started/quick-install.md
diff --git a/_docs-unreleased/getting-started/shell.md b/_docs-2-0/getting-started/shell.md
similarity index 100%
rename from _docs-unreleased/getting-started/shell.md
rename to _docs-2-0/getting-started/shell.md
diff --git a/_docs-unreleased/getting-started/table_configuration.md b/_docs-2-0/getting-started/table_configuration.md
similarity index 100%
rename from _docs-unreleased/getting-started/table_configuration.md
rename to _docs-2-0/getting-started/table_configuration.md
diff --git a/_docs-unreleased/getting-started/table_design.md b/_docs-2-0/getting-started/table_design.md
similarity index 100%
rename from _docs-unreleased/getting-started/table_design.md
rename to _docs-2-0/getting-started/table_design.md
diff --git a/_docs-unreleased/index.md b/_docs-2-0/index.md
similarity index 100%
rename from _docs-unreleased/index.md
rename to _docs-2-0/index.md
diff --git a/_docs-unreleased/troubleshooting/advanced.md b/_docs-2-0/troubleshooting/advanced.md
similarity index 100%
rename from _docs-unreleased/troubleshooting/advanced.md
rename to _docs-2-0/troubleshooting/advanced.md
diff --git a/_docs-unreleased/troubleshooting/basic.md b/_docs-2-0/troubleshooting/basic.md
similarity index 100%
rename from _docs-unreleased/troubleshooting/basic.md
rename to _docs-2-0/troubleshooting/basic.md
diff --git a/_docs-unreleased/troubleshooting/system-metadata-tables.md b/_docs-2-0/troubleshooting/system-metadata-tables.md
similarity index 100%
rename from _docs-unreleased/troubleshooting/system-metadata-tables.md
rename to _docs-2-0/troubleshooting/system-metadata-tables.md
diff --git a/_docs-unreleased/troubleshooting/tools.md b/_docs-2-0/troubleshooting/tools.md
similarity index 100%
rename from _docs-unreleased/troubleshooting/tools.md
rename to _docs-2-0/troubleshooting/tools.md
diff --git a/_layouts/docs-unreleased.html b/_layouts/docs-2.0.html
similarity index 97%
rename from _layouts/docs-unreleased.html
rename to _layouts/docs-2.0.html
index 39af0c8..f9f1613 100644
--- a/_layouts/docs-unreleased.html
+++ b/_layouts/docs-2.0.html
@@ -7,7 +7,7 @@ skiph1fortitle: true
   <div class="col-md-3">
     <div class="panel-group" id="accordion" role="tablist" aria-multiselectable="true"
data-spy="affix">
       <div class="panel panel-default">
-      {% assign mydocs = site.docs-unreleased | group_by: 'category' %}
+      {% assign mydocs = site.docs-2-0 | group_by: 'category' %}
       {% assign categories = "getting-started,development,administration,troubleshooting"
| split: "," %}
       {% for pcat in categories %}
         {% for dcat in mydocs %}
diff --git a/_posts/blog/2017-06-29-accumulo-documentation-improvements.md b/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
index 5bc06ad..d42d94c 100644
--- a/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
+++ b/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
@@ -8,21 +8,20 @@ an HTML document is produced from the asciidoc, committed to the [project
websit
 for 1.x releases.
 
 For 2.0, the source for the user manual was converted to markdown and moved to the [website
repository][website-repo]. The
-[upcoming 2.0 documentation][unreleased-docs] has several improvements over the older documentation:
+[upcoming 2.0 documentation][docs-2.0] has several improvements over the older documentation:
 
 * Improved navigation using a new sidebar
 * Changes to the documentation are now immediately viewable on the website
 * Better linking to Javadocs and between documentation pages
 * Documentation style now matches the website
 
-While the [unreleased documentation][unreleased-docs] is viewable, it is not linked to (except
by this post) and every page contains a warning that the documentation
+While the [2.0 documentation][docs-2.0] is viewable, it is not linked to (except by this
post) and every page contains a warning that the documentation
 is for a future release. Each page also links to the documentation for the latest release.
 
-It is now much easier to view, edit, and propose changes to the documentation. If you would
like to contribute to the documentation for 2.0, view
-the [unreleased documentation][unreleased-docs]. Each page has an **Edit this page** link
that will take you to GitHub where you can edit the markdown for the page, preview it,
+
 and submit a pull request to the [website repository][website-repo]. A committer will review
your changes so don't be afraid to contribute!
 
 [manual]: /1.8/accumulo_user_manual.html
 [accumulo-repo]: https://github.com/apache/accumulo
 [website-repo]: https://github.com/apache/accumulo-website
-[unreleased-docs]: /docs/unreleased/
+[docs-2.0]: /docs/2.0/
diff --git a/contributor/making-release.md b/contributor/making-release.md
index 9055976..1bde7b5 100644
--- a/contributor/making-release.md
+++ b/contributor/making-release.md
@@ -131,16 +131,17 @@ for two markdown files that should be changed in the Accumulo repo and
copied/mi
 
         cp /path/to/accumulo/core/target/generated-docs/configuration-properties.md /path/to/accumulo-website/_docs-2-x/administration/configuration-properties.md
 
-**For 2.x minor releases,** follow the steps below:
+**For 2.x minor releases,** follow the steps below to create docs for next release:
 
-1. Create a new documentation collection for the new minor release (i.e `2.0`) using the
unreleased collection. Avoid using a dot `.` in the directory name:
+1. Create a new documentation collection for the new minor release (i.e `2.0`) using the
collection of the last release. Avoid using a dot `.` in
+   the directory name:
 
-        cp -r _docs-unreleased _docs-2-0
+        cp -r _docs-2-0 _docs-2-1
 
-2. Create a new doc layout using the unreleased layout. Update the reference to `site.docs-unreleased`
to `site.docs-2-0` (if making 2.0 release):
+2. Create a new doc layout using the previous layout. Update the reference to `site.docs-2-0`
to `site.docs-2-1` (if creating 2.1 docs):
 
-        cp _layouts/docs-unreleased.html _layouts/docs-2.0.html
-        vim _layouts/docs-2.0.html
+        cp _layouts/docs-2.0.html _layouts/docs-2.1.html
+        vim _layouts/docs-2.1.html
 
 3. Point Jekyll to the new documentation collection by modifying `collections` and `defaults`
in `_config.yml`. Follow what was done for previous
    releases.

-- 
To stop receiving notification emails like this one, please contact
['"commits@accumulo.apache.org" <commits@accumulo.apache.org>'].

Mime
View raw message