apache / accumulo-website Goto Github PK

There are a lot of places in the css files that can be cleaned up and/or removed.

Also, there are a lot of inline styles that could be replaced with bootstrap classes which would clean things up.

The release notes for 2.0.0 need to be finished. Below is a link to the notes.

https://github.com/apache/accumulo-website/blob/master/_posts/release/2017-09-05-accumulo-2.0.0.md

Please comment on this issue with anything you think should be mentioned in the release notes.

Since the yielding feature was added back in release 1.9.0, we have been missing a chapter on how to use it.

Create step-by-step instructions to help users move from 1.9 to 2.0.

To create these instructions, it might be helpful to run Accumulo 1.9, stop it, and write up all instructions necessary to start up instance again as Accumulo 2.0.

These instructions should be linked to from 2.0.0 release notes

With the next release, this section of the user manual needs to be updated accordingly: https://accumulo.apache.org/docs/2.x/getting-started/features#extensible-behaviors
The balancer is now part of the SPI and I think this would be a good place to describe the new SPI package. I think the 3 other sections can be removed.

Update the client API link to link to the api page. Possibly add API to the top navbar.

@hkeebler and @alerman were recently voted as committers/PMC members to Accumulo.

I'm creating this issue to encourage them to use their new privileges to commit directly to an Accumulo repository, and the easiest first commit is normally to each move themselves from the contributors section to the PMC section of the people page on the website.

https://accumulo.apache.org/contributor/making-release

There is a lot of good info on this page but it is a little hard to follow. A nice TODO list at the top of the page, linking to each section would be great. @ctubbsii [VOTE] Apache Accumulo 1.9.3-rc3 email on the release vote made me think of this.

https://issues.apache.org/jira/browse/ACCUMULO-4463 added the ability in 2.0.0 for a user to specify their own cache implementation. @keith-turner and I tested two off-heap implementations, Apache Ignite and https://github.com/keith-turner/accumulo-ohc. This should be mentioned in https://accumulo.apache.org/docs/2.x/getting-started/features#extensible-behaviors and https://accumulo.apache.org/docs/2.x/administration/caching

Check for references to the other old files too

Users need to build Properties object and pass them to new M/R builder.

Not sure if its something we want to do but there is a blog post, linked here, detailing how to use Hadoop Metrics 2 with Grafana that could be superseded/replaced/updated by a similar post regarding this process with the new Metrics implementation. This comment from @dlmarion looks like it could be a great starting place for such a post.

Originally posted by @DomGarguilo in #298 (comment)

When Accumulo 2.0 is released, the 'Features' & 'Glossary' pages could become pages under 'Getting Started' tab in the documentation.

Original issue: https://issues.apache.org/jira/browse/ACCUMULO-4711

Based off of JIRA ticket: 3694.

Add documentation (either the tools or troubleshooting docs) detailing how to recover and reset the root password with the accumulo init --reset-security tool along with the repercussions of doing so.

Specifically, number 3 in Setup

At least one person on our PMC is now Emeritus (for that role, but remains a committer). The "people" page needs to be updated to be able to mark such individuals as Emeritus. Right now, it lists all PMC and committers in one big list. There are probably several different design options. Maybe using datatables could work to organize the list of contributors/committers/PMC members/Emeritus PMC members? Or just a separate "Committers / Emeritus PMC Members" section.

If anybody is interested in doing this, they could also suggest a similarly styled update over on the Fluo project for apache/fluo-website#216

BasicCompactionStrategy link in
https://accumulo.apache.org/docs/2.x/getting-started/table_configuration#compaction-strategies routes to error:

<Error>
   <Code>AccessDenied</Code>
   <Message>Access Denied</Message>
   <RequestId>5EC59568E1C3EE6F</RequestId>
   <HostId>ud1AeJXLawFywfoFx69lVhPQCdQp0omjPABSwgyzjtWl8lv+jwcUg0iGgxR/cRXVxtK9TcIG0dM=</HostId>
</Error>

Create a blog post or add something to the user manual about these notes.

https://gist.github.com/keith-turner/f6dcbd33342732e42695d66509239983

Consider updating the website API docs to suggest using the approach used in apache/accumulo-testing#52 instead of the current regex.

Recently saw a talk by @joshelser about running Accumulo and HBase in AWS and Azure. He mentioned that bulk import may need s3guard because the operation lists files. Need to add this information to the blog post. @joshelser do you have a link to your talk that I could add to the blog post?

Fate has a specific layout in zookeeper. It should be documented.

Originally a JIRA issue: https://issues.apache.org/jira/browse/ACCUMULO-1298

The current docs on the website are specifically 2.x docs, and 3.0.0 removes and changes things, so that we can't just update the docs overwriting what is there, like we could with backwards-compatible 2.x updates. We can either redesign the common docs to allow version-specific documentation, or we can copy over the whole Jekyll docs-2.x collection for 3.x and put them in a different directory. If we do that, we'll have to update the Jekyll ruby plugin to support the convenience links that we had before that currently only work with 2.x.

This involves understanding how the _config.yml file properties, the _docs-2/ collection, the generated client and server properties in _docs-2/configuration/ the _docs-2/apidocs, and the _plugins/links.rb all work together, and updating it all to support both the 2.x docs and the 3.x docs.

Original issue: https://issues.apache.org/jira/browse/ACCUMULO-4738

This builds on ACCUMULO-4714.

The contributor's guide was consolidated into one page. There is still some historical information that is very verbose (see /contributors-guide/#workflow-background for example). It would be nice to simplify these sections while keeping necessary information.

The instructions say to upload the artifacts to a SVN repo here. Having not used svn in over a decade, it would be very useful to have example CLI instructions.

There is an end of life project that provides recommendations on documenting EOL policies recommendations.

Accumulo has adopted a formal EOL policy and we may want to structure our documentation to adopt the conventions suggested.

Several libraries we use for the website are a bit out of date and could be updated. Here's a list of some:

• Bootstrap (currently using 3.3.7)
• Font Awesome (currently using 4.0.3)
• DataTables (currently using 1.10.12 based on jQuery 2.2.3)
• jQuery (currently using 2.2.4)

Edit:
The above dependencies are all imported in default.html. The search page imports its own dependencies that need updating:

• lunr
• jquery

The following page needs to be updated for 2.0

https://accumulo.apache.org/api/

In accumulo home page use jquery like this:
https://ajax.googleapis.com/ajax/libs/jquery/2.2.4/jquery.min.js
As well know google domain name will be very slow or blocked in China.

It would be great to have a way to easily search the Accumulo 2.0+ documentation.

With the recent changes to metrics, it looks like the metrics page needs updating to reflect the replacement of Hadoop Metrics 2 with Micrometer.

Tagging new committer @lstav to perform first commit to the website to add self to website.

Website rebuild instructions are in this repository's README.

Create an On Disk encryption section for the new crypto stuff in 2.0 https://github.com/apache/accumulo-website/tree/master/_docs-2-0

It would be nice to do this before releasing, but it does not have to be done. Marking it as a blocker so its not forgotten before release.

There are some broken links in the docs that need updating/fixing. I briefly looked through some of the pages and there are probably others but here are a few that I found:

• The log4j links probably need to be updated to lo4j2 in this section: https://accumulo.apache.org/docs/2.x/administration/in-depth-install#configuration
• Looks like the manager and tserver link needs to be corrected in this sections: https://accumulo.apache.org/docs/2.x/administration/in-depth-install#cluster-specification
• The Zookeeper acls link in this section: https://accumulo.apache.org/docs/2.x/administration/upgrading#upgrading-from-110-or-20-to-21

Issue

There needs to be some documentation on which Java versions are supported.

Background

I just tried running the tour, but I'm getting an exception. I suspect the problem is that I'm using Java >= 9, (in my case, Java 11), and there were changes to the way class loaders worked?

I also tried updating the accumulo.version to 1.9.2 in the pom.xml but that had no effect.

Here's the last few lines of my output (no quiet mode):

Command

$ mvn clean compile exec:java

Output

[INFO] --- exec-maven-plugin:1.5.0:java (default-cli) @ accumulo-tour ---
Running the Accumulo tour. Having fun yet?
[WARNING]
java.lang.reflect.InvocationTargetException
    at jdk.internal.reflect.NativeMethodAccessorImpl.invoke0 (Native Method)
    at jdk.internal.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:62)
    at jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke (Method.java:566)
    at org.codehaus.mojo.exec.ExecJavaMojo$1.run (ExecJavaMojo.java:294)
    at java.lang.Thread.run (Thread.java:834)
Caused by: java.lang.IllegalArgumentException: Unknown classloader type : jdk.internal.loader.ClassLoaders$AppClassLoader
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterImpl.getClasspath (MiniAccumuloClusterImpl.java:270)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterImpl._exec (MiniAccumuloClusterImpl.java:288)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterImpl._exec (MiniAccumuloClusterImpl.java:364)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterControl.start (MiniAccumuloClusterControl.java:161)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterControl.start (MiniAccumuloClusterControl.java:137)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterControl.start (MiniAccumuloClusterControl.java:69)
    at org.apache.accumulo.minicluster.impl.MiniAccumuloClusterImpl.start (MiniAccumuloClusterImpl.java:571)
    at org.apache.accumulo.minicluster.MiniAccumuloCluster.start (MiniAccumuloCluster.java:70)
    at tour.Main.main (Main.java:29)
    at jdk.internal.reflect.NativeMethodAccessorImpl.invoke0 (Native Method)
    at jdk.internal.reflect.NativeMethodAccessorImpl.invoke (NativeMethodAccessorImpl.java:62)
    at jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke (DelegatingMethodAccessorImpl.java:43)
    at java.lang.reflect.Method.invoke (Method.java:566)
    at org.codehaus.mojo.exec.ExecJavaMojo$1.run (ExecJavaMojo.java:294)
    at java.lang.Thread.run (Thread.java:834)
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  1.726 s
[INFO] Finished at: 2019-01-25T16:09:43-05:00
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.5.0:java (default-cli) on project accumulo-tour: An exception occured while executing the Java class. null: InvocationTargetException: Unknown classloader type : jdk.internal.loader.ClassLoaders$AppClassLoader -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException

Java version:

$ java -version
java version "11.0.1" 2018-10-16 LTS
Java(TM) SE Runtime Environment 18.9 (build 11.0.1+13-LTS)
Java HotSpot(TM) 64-Bit Server VM 18.9 (build 11.0.1+13-LTS, mixed mode)

Maven version:

$ mvn -v
Apache Maven 3.6.0 (97c98ec64a1fdfee7767ce5ffb20918da4f719f3; 2018-10-24T14:41:47-04:00)
Maven home: /usr/local/Cellar/maven/3.6.0/libexec
Java version: 11.0.1, vendor: Oracle Corporation, runtime: /Library/Java/JavaVirtualMachines/jdk-11.0.1.jdk/Contents/Home
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.14.2", arch: "x86_64", family: "mac"

Conference is over

Page contains %{ jlink org.apache.accumulo.core.metrics.MetricsProducer %}.

The table here: https://accumulo.apache.org/docs/2.x/administration/in-depth-install#network

Many of the entries in the table are deprecated or have broken links. It should be determined whether any should be removed or fixed.

After apache/accumulo#2807 is merged the documentation will need to be updated with instructions for the new tools that are being added to the accumulo command.

This corresponds to apache/accumulo#684
The plugin documentation can be relatively easily generated with maven-site-plugin. See other maven plugin documentation for examples:

https://code.revelc.net/impsort-maven-plugin/
https://code.revelc.net/apilyzer-maven-plugin/

Need to update the following docs to reflect the changes in apache/accumulo#935

https://accumulo.apache.org/docs/2.x/getting-started/table_configuration#compaction-strategies

In the recent blog post on 2.1.0 Metrics and Tracing Changes, the command to start the TIG docker container fails to run. The --rm and --restart command cannot not be used at the same time.

One of the two options needs to be removed. Once that happens, the container will start as expected.

Original Jira ticket: https://issues.apache.org/jira/browse/ACCUMULO-2469

The Jira ticket mentions the steps though I have not verified if that is still accurate or if it could be improved upon.

Tagging new committer @jmark99 to perform first commit to the website to add self to website.

Website rebuild instructions are in this repository's README.

The 2.x documentation for Tracing has references to a class (specifically org.apache.accumulo.core.trace.DistributedTrace) that doesn't exist in 2.x anymore. See:
https://accumulo.apache.org/docs/2.x/troubleshooting/tracing#instrumenting-a-client

Consider re-working the Accumulo Tour to use the newer JShell feature.

An advantage would be that user could immediately start exercising Accumulo features without having to set up a development environment since work would be done within the Accumulo Shell. It would involve users setting up an Accumulo instance either via Fluo-Uno, Accumulo MiniCluster, or some other means.

The existing Tour could remain to allow users either option if desired.

To support linking to property documentation from Javadocs, it would be nice if the website offered stable way to do this. For example the following link could show the docs for the table.scan.dispatcher property.

https://apache.accumulo.org/docs/property/table.scan.dispatcher

Could start off with this redirecting to the docs for the latest version and change the behavior over time.
For example, it could link to the the docs for different versions of a prop and show the description from the latest version.