accumulo-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mwa...@apache.org
Subject [1/2] accumulo-website git commit: Blog post about improvements to the documentation
Date Fri, 30 Jun 2017 15:59:59 GMT
Repository: accumulo-website
Updated Branches:
  refs/heads/master 8f3e481f8 -> 7fbaf666b


Blog post about improvements to the documentation

* Also made minor fixes to unreleased documentation


Project: http://git-wip-us.apache.org/repos/asf/accumulo-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo-website/commit/954ed0fa
Tree: http://git-wip-us.apache.org/repos/asf/accumulo-website/tree/954ed0fa
Diff: http://git-wip-us.apache.org/repos/asf/accumulo-website/diff/954ed0fa

Branch: refs/heads/master
Commit: 954ed0fadb5dd556a0d836ba01a51b28cfd2f611
Parents: 4e7894f
Author: Mike Walch <mwalch@apache.org>
Authored: Thu Jun 29 11:12:55 2017 -0400
Committer: Mike Walch <mwalch@apache.org>
Committed: Fri Jun 30 11:58:11 2017 -0400

----------------------------------------------------------------------
 _docs-unreleased/index.md                       |  5 ++--
 _layouts/docs-unreleased.html                   |  2 +-
 ...06-29-accumulo-documentation-improvements.md | 28 ++++++++++++++++++++
 3 files changed, 31 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/954ed0fa/_docs-unreleased/index.md
----------------------------------------------------------------------
diff --git a/_docs-unreleased/index.md b/_docs-unreleased/index.md
index 02e840c..750ad7e 100644
--- a/_docs-unreleased/index.md
+++ b/_docs-unreleased/index.md
@@ -11,6 +11,5 @@ Use the sidebar to left the navigate the documentation.
 
 The links below contain additional documentation for this release:
 
-* [Release notes](/release/accumulo-1.8.1)
-* [Javadocs](/1.8/apidocs)
-* [Examples](/1.8/examples)
+* [Release notes](/release/accumulo-2.0.0)
+* [Javadocs](/2.0/apidocs)

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/954ed0fa/_layouts/docs-unreleased.html
----------------------------------------------------------------------
diff --git a/_layouts/docs-unreleased.html b/_layouts/docs-unreleased.html
index 6d6c519..39af0c8 100644
--- a/_layouts/docs-unreleased.html
+++ b/_layouts/docs-unreleased.html
@@ -37,10 +37,10 @@ skiph1fortitle: true
     {% if page.category %}
     <p><a href="{{ site.baseurl }}/docs/{{ page.version }}/">Accumulo {{ page.version
}} docs</a> &nbsp;&gt;&gt;&nbsp; {{ page.category | capitalize | replace:
"-", " " }} &nbsp;&gt;&gt;&nbsp; {{ page.title }}</p>
     {% endif %}
-    {% unless page.nodoctitle %}
 
     <div class="alert alert-danger" style="margin-bottom: 0px;" role="alert">This documentation
is for a future release of Accumulo! <a href="{{ site.baseurl }}/{{ site.latest_minor_release
}}/accumulo_user_manual.html">View documentation for the latest release</a>.</div>
 
+    {% unless page.nodoctitle %}
     <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/master/{{
page.path }}" role="button"><i class="glyphicon glyphicon-pencil"></i> <small>Edit
this page</small></a></div>

http://git-wip-us.apache.org/repos/asf/accumulo-website/blob/954ed0fa/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
----------------------------------------------------------------------
diff --git a/_posts/blog/2017-06-29-accumulo-documentation-improvements.md b/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
new file mode 100644
index 0000000..82f7cb5
--- /dev/null
+++ b/_posts/blog/2017-06-29-accumulo-documentation-improvements.md
@@ -0,0 +1,28 @@
+---
+title: "Documentation Improvements for 2.0"
+author: Mike Walch
+---
+
+Since Accumulo 1.5, the [Accumulo user manual][manual] source resided in the [source repository][accumulo-repo]
as asciidoc. For every release or update to the manual,
+an HTML document is produced from the asciidoc, committed to the [project website repository][website-repo],
and published to the website. This process will remain
+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:
+
+* 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
+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/


Mime
View raw message