ACCUMULO-4630 Move user manual to Accumulo website * removed user manual asciidoc and moved it to accumulo-website repo * binary tarball no longer contains user manual * moved configuration mgmt docs in 'config-header.txt' to website * ConfigurationDocGen.java now generates markdown for website during core module build to core/target/generated-docs
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/e99ec9f0 Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/e99ec9f0 Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/e99ec9f0 Branch: refs/heads/master Commit: e99ec9f0d65c736784b56f45a4c0833c7f4530cf Parents: 2e171cd Author: Mike Walch <mwa...@apache.org> Authored: Wed May 17 16:30:35 2017 -0400 Committer: Mike Walch <mwa...@apache.org> Committed: Mon May 22 13:37:14 2017 -0400 ---------------------------------------------------------------------- README.md | 14 +- assemble/conf/accumulo-site.xml | 4 +- assemble/pom.xml | 7 - assemble/src/main/assemblies/component.xml | 14 - core/pom.xml | 35 + .../accumulo/core/conf/ConfigurationDocGen.java | 170 +-- .../org/apache/accumulo/core/conf/Property.java | 2 +- .../apache/accumulo/core/conf/config-header.txt | 102 -- docs/.gitignore | 28 - docs/pom.xml | 144 --- .../main/asciidoc/accumulo_user_manual.asciidoc | 76 -- .../main/asciidoc/chapters/administration.txt | 1145 ------------------ docs/src/main/asciidoc/chapters/analytics.txt | 229 ---- docs/src/main/asciidoc/chapters/clients.txt | 403 ------ docs/src/main/asciidoc/chapters/design.txt | 180 --- .../asciidoc/chapters/development_clients.txt | 107 -- .../asciidoc/chapters/high_speed_ingest.txt | 124 -- .../main/asciidoc/chapters/implementation.txt | 86 -- .../src/main/asciidoc/chapters/introduction.txt | 25 - .../main/asciidoc/chapters/iterator_design.txt | 401 ------ .../asciidoc/chapters/iterator_test_harness.txt | 110 -- docs/src/main/asciidoc/chapters/kerberos.txt | 663 ---------- docs/src/main/asciidoc/chapters/multivolume.txt | 82 -- docs/src/main/asciidoc/chapters/replication.txt | 399 ------ docs/src/main/asciidoc/chapters/sampling.txt | 86 -- docs/src/main/asciidoc/chapters/security.txt | 182 --- docs/src/main/asciidoc/chapters/shell.txt | 159 --- docs/src/main/asciidoc/chapters/ssl.txt | 134 -- docs/src/main/asciidoc/chapters/summaries.txt | 232 ---- .../asciidoc/chapters/table_configuration.txt | 670 ---------- .../src/main/asciidoc/chapters/table_design.txt | 336 ----- .../main/asciidoc/chapters/troubleshooting.txt | 845 ------------- docs/src/main/asciidoc/images/accumulo-logo.png | Bin 11427 -> 0 bytes .../main/asciidoc/images/data_distribution.png | Bin 86937 -> 0 bytes .../main/asciidoc/images/failure_handling.png | Bin 48905 -> 0 bytes .../resources/design/ACCUMULO-378-design.mdtext | 468 ------- .../main/resources/state/replicationstatus.gv | 40 - .../main/resources/state/replicationstatus.png | Bin 65414 -> 0 bytes .../src/main/resources/state/table-lifecycle.gv | 77 -- .../main/resources/state/table-lifecycle.png | Bin 190640 -> 0 bytes pom.xml | 13 - 41 files changed, 96 insertions(+), 7696 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index dcd5632..a4e4830 100644 --- a/README.md +++ b/README.md @@ -32,18 +32,16 @@ Installation Follow [these instructions][install] to install and run an Accumulo binary distribution. -Documentation -------------- +Resources +--------- -Apache Accumulo has the following documentation: +Apache Accumulo publishes the following resources with each release: -* [User Manual][manual] - In-depth developer and administrator documentation. - - Available in binary tarball at `docs/accumulo_user_manual.html` - - Available in source tarball at `docs/src/main/asciidoc` +* [Documentation][docs] - In-depth developer and administrator documentation * [Accumulo Examples][examples] - Documented example code for using Accumulo * [Javadocs][javadocs] - Accumulo API documentation -More documentation can be found on the [project website][accumulo]. +More resources can be found on the [project website][accumulo]. Building -------- @@ -129,7 +127,7 @@ more details on bouncycastle's cryptography features. [Thrift]: https://thrift.apache.org [features]: https://accumulo.apache.org/notable_features [Maven]: https://maven.apache.org -[manual]: https://accumulo.apache.org/latest/accumulo_user_manual +[docs]: https://accumulo.apache.org/latest/accumulo_user_manual [examples]: https://github.com/apache/accumulo-examples [javadocs]: https://accumulo.apache.org/latest/apidocs [semver]: http://semver.org/spec/v2.0.0 http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/assemble/conf/accumulo-site.xml ---------------------------------------------------------------------- diff --git a/assemble/conf/accumulo-site.xml b/assemble/conf/accumulo-site.xml index a617484..6be99e7 100644 --- a/assemble/conf/accumulo-site.xml +++ b/assemble/conf/accumulo-site.xml @@ -16,8 +16,8 @@ limitations under the License. --> <?xml-stylesheet type="text/xsl" href="configuration.xsl"?> -<!-- This is the main configuration file for Apache Accumulo. Available configuration properties - (and their default values) can be found in the user manual (docs/accumulo_user_manual.html). --> +<!-- This is the main configuration file for Apache Accumulo. Available configuration properties can be + found in the Accumulo documentation on the Accumulo project website (https://accumulo.apache.org/) --> <configuration> <!-- Set location in HDFS where Accumulo will store data --> <property> http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/assemble/pom.xml ---------------------------------------------------------------------- diff --git a/assemble/pom.xml b/assemble/pom.xml index c2fdb69..259ffdb 100644 --- a/assemble/pom.xml +++ b/assemble/pom.xml @@ -73,13 +73,6 @@ </dependency> <dependency> <groupId>org.apache.accumulo</groupId> - <artifactId>accumulo-docs</artifactId> - <classifier>user-manual</classifier> - <type>html</type> - <optional>true</optional> - </dependency> - <dependency> - <groupId>org.apache.accumulo</groupId> <artifactId>accumulo-fate</artifactId> <optional>true</optional> </dependency> http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/assemble/src/main/assemblies/component.xml ---------------------------------------------------------------------- diff --git a/assemble/src/main/assemblies/component.xml b/assemble/src/main/assemblies/component.xml index a346ab2..f28b2c6 100644 --- a/assemble/src/main/assemblies/component.xml +++ b/assemble/src/main/assemblies/component.xml @@ -51,20 +51,6 @@ <include>org.slf4j:slf4j-log4j12</include> <include>log4j:log4j</include> </includes> - <excludes> - <exclude>${groupId}:${artifactId}-docs</exclude> - </excludes> - </dependencySet> - <dependencySet> - <outputDirectory>docs</outputDirectory> - <directoryMode>0755</directoryMode> - <fileMode>0644</fileMode> - <useProjectArtifact>false</useProjectArtifact> - <outputFileNameMapping>${artifactId}_user_manual.${artifact.extension}</outputFileNameMapping> - <useTransitiveDependencies>false</useTransitiveDependencies> - <includes> - <include>${groupId}:${artifactId}-docs:html:user-manual</include> - </includes> </dependencySet> </dependencySets> <fileSets> http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/core/pom.xml ---------------------------------------------------------------------- diff --git a/core/pom.xml b/core/pom.xml index aec7f66..96510f5 100644 --- a/core/pom.xml +++ b/core/pom.xml @@ -259,6 +259,41 @@ </execution> </executions> </plugin> + <plugin> + <groupId>org.codehaus.mojo</groupId> + <artifactId>exec-maven-plugin</artifactId> + <executions> + <execution> + <id>prep-output-dir</id> + <goals> + <goal>exec</goal> + </goals> + <phase>compile</phase> + <configuration> + <executable>mkdir</executable> + <arguments> + <argument>-p</argument> + <argument>${project.build.directory}/generated-docs</argument> + </arguments> + </configuration> + </execution> + <execution> + <id>config-appendix</id> + <goals> + <goal>java</goal> + </goals> + <phase>compile</phase> + <configuration> + <mainClass>org.apache.accumulo.core.conf.ConfigurationDocGen</mainClass> + <classpathScope>compile</classpathScope> + <arguments> + <argument>--generate-markdown</argument> + <argument>${project.build.directory}/generated-docs/configuration-properties.md</argument> + </arguments> + </configuration> + </execution> + </executions> + </plugin> </plugins> </build> <profiles> http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java index f724936..e103e69 100644 --- a/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java +++ b/core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java @@ -19,16 +19,10 @@ package org.apache.accumulo.core.conf; import static java.nio.charset.StandardCharsets.UTF_8; import java.io.FileNotFoundException; -import java.io.IOException; -import java.io.InputStream; import java.io.PrintStream; import java.io.UnsupportedEncodingException; -import java.util.ArrayList; import java.util.TreeMap; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - /** * This class generates documentation to inform users of the available configuration properties in a presentable form. */ @@ -37,115 +31,90 @@ class ConfigurationDocGen { abstract void beginSection(String section); - void endSection() {} - void generate() { pageHeader(); - beginSection("Available Properties"); - propertyQuickLinks(); - for (Property prefix : prefixes) { - if (!prefix.isExperimental()) { - prefixSection(prefix); - for (Property prop : sortedProps.values()) { - if (!prop.isExperimental()) { - property(prefix, prop); - } + beginTable("Property"); + for (Property prop : sortedProps.values()) { + if (!prop.isExperimental()) { + if (prop.getType() == PropertyType.PREFIX) { + prefixSection(prop); + } else { + property(prop); } } } - endSection(); beginSection("Property Types"); + beginTable("Type"); propertyTypeDescriptions(); - endSection(); - pageFooter(); doc.close(); } - abstract String getExt(); - - void pageFooter() {} + abstract void beginTable(String name); - // read static header content from resources and output - void pageHeader() { - appendResource("config-header." + getExt()); - doc.println(); - } + abstract void pageHeader(); abstract void prefixSection(Property prefix); - abstract void property(Property prefix, Property prop); + abstract void property(Property prop); abstract void propertyTypeDescriptions(); - abstract void propertyQuickLinks(); - - abstract String sanitize(String str); - } - private class Asciidoc extends Format { + private class Markdown extends Format { + @Override void beginSection(String section) { - doc.println("=== " + section); + doc.println("\n### " + section + "\n"); } @Override - String getExt() { - return "txt"; + void beginTable(String name) { + doc.println("| " + name + " | Description |"); + doc.println("|--------------|-------------|"); } @Override - void propertyQuickLinks() { - doc.println("Jump to: "); - String delimiter = ""; - for (Property prefix : prefixes) { - if (!prefix.isExperimental()) { - doc.print(delimiter + "<<" + prefix.name() + ">>"); - delimiter = " | "; - } - } - doc.println(); - doc.println(); + void pageHeader() { + doc.println("---"); + doc.println("title: Configuration Properties"); + doc.println("category: administration"); + doc.println("order: 3"); + doc.println("---\n"); + doc.println("<!-- WARNING: Do not edit this file. It is a generated file that is copied from Accumulo build (from core/target/generated-docs) -->\n"); } @Override void prefixSection(Property prefix) { boolean depr = prefix.isDeprecated(); - doc.println("[[" + prefix.name() + "]]"); - doc.println("==== " + prefix.getKey() + "*" + (depr ? " (Deprecated)" : "")); - doc.println(strike((depr ? "_Deprecated._ " : "") + sanitize(prefix.getDescription()), depr)); - doc.println(); + doc.print("| <a name=\"" + prefix.getKey().replace(".", "_") + "prefix\"></a> **" + prefix.getKey() + "*** | "); + doc.println((depr ? "**Deprecated.** " : "") + strike(sanitize(prefix.getDescription()), depr) + " |"); } @Override - void property(Property prefix, Property prop) { - boolean depr = prefix.isDeprecated() || prop.isDeprecated(); - if (prop.getKey().startsWith(prefix.getKey())) { - doc.println("===== " + prop.getKey()); - doc.println(strike((depr ? "_Deprecated._ " : "") + sanitize(prop.getDescription()), depr)); - doc.println(); - doc.println(strike("_Type:_ " + prop.getType().name(), depr) + " +"); - doc.println(strike("_Zookeeper Mutable:_ " + isZooKeeperMutable(prop), depr) + " +"); - String defaultValue = sanitize(prop.getRawDefaultValue()).trim(); - if (defaultValue.length() == 0) { - // need a placeholder or the asciidoc line break won't work - defaultValue = strike("_Default Value:_ _empty_", depr); - } else if (defaultValue.contains("\n")) { - // deal with multi-line values, skip strikethrough of value - defaultValue = strike("_Default Value:_ ", depr) + "\n----\n" + defaultValue + "\n----\n"; - } else { - defaultValue = strike("_Default Value:_ " + "`" + defaultValue + "`", depr); - } - doc.println(defaultValue); - doc.println(); + void property(Property prop) { + boolean depr = prop.isDeprecated(); + doc.print("| <a name=\"" + prop.getKey().replace(".", "_") + "\"></a> " + prop.getKey() + " | "); + doc.print((depr ? "**Deprecated.** " : "") + strike(sanitize(prop.getDescription()), depr) + "<br>"); + doc.print(strike("**type:** " + prop.getType().name(), depr) + ", "); + doc.print(strike("**zk mutable:** " + isZooKeeperMutable(prop), depr) + ", "); + String defaultValue = sanitize(prop.getRawDefaultValue()).trim(); + if (defaultValue.length() == 0) { + defaultValue = strike("**default value:** empty", depr); + } else if (defaultValue.contains("\n")) { + // deal with multi-line values, skip strikethrough of value + defaultValue = strike("**default value:** ", depr) + "\n```\n" + defaultValue + "\n```\n"; + } else { + defaultValue = strike("**default value:** " + "`" + defaultValue + "`", depr); } + doc.println(defaultValue + " |"); } private String strike(String s, boolean isDeprecated) { - return (isDeprecated ? "[line-through]#" : "") + s + (isDeprecated ? "#" : ""); + return (isDeprecated ? "~~" : "") + s + (isDeprecated ? "~~" : ""); } @Override @@ -153,58 +122,23 @@ class ConfigurationDocGen { for (PropertyType type : PropertyType.values()) { if (type == PropertyType.PREFIX) continue; - doc.println("==== " + sanitize(type.toString())); - doc.println(sanitize(type.getFormatDescription())); - doc.println(); + doc.println("| " + sanitize(type.toString()) + " | " + sanitize(type.getFormatDescription()) + " |"); } } - @Override String sanitize(String str) { - return str; + return str.replace("\n", "<br>"); } } - private static final Logger log = LoggerFactory.getLogger(ConfigurationDocGen.class); - private PrintStream doc; - - private final ArrayList<Property> prefixes; - - private final TreeMap<String,Property> sortedProps; + private final TreeMap<String,Property> sortedProps = new TreeMap<>(); private ConfigurationDocGen(PrintStream doc) { this.doc = doc; - this.prefixes = new ArrayList<>(); - this.sortedProps = new TreeMap<>(); - for (Property prop : Property.values()) { - if (prop.isExperimental()) - continue; - - if (prop.getType() == PropertyType.PREFIX) - this.prefixes.add(prop); - else + if (!prop.isExperimental()) { this.sortedProps.put(prop.getKey(), prop); - } - } - - private void appendResource(String resourceName) { - InputStream data = ConfigurationDocGen.class.getResourceAsStream(resourceName); - if (data != null) { - byte[] buffer = new byte[1024]; - int n; - try { - while ((n = data.read(buffer)) > 0) - doc.print(new String(buffer, 0, n, UTF_8)); - } catch (IOException e) { - log.debug("Encountered IOException while reading InputStream in appendResource().", e); - } finally { - try { - data.close(); - } catch (IOException ex) { - log.error("{}", ex.getMessage(), ex); - } } } } @@ -217,12 +151,12 @@ class ConfigurationDocGen { return "yes"; } - private void generateAsciidoc() { - new Asciidoc().generate(); + private void generateMarkdown() { + new Markdown().generate(); } /** - * Generates documentation for accumulo-site.xml file usage. Arguments are: "--generate-asciidoc filename" + * Generates documentation for accumulo-site.xml file usage. Arguments are: "--generate-markdown filename" * * @param args * command-line arguments @@ -230,10 +164,10 @@ class ConfigurationDocGen { * if args is invalid */ public static void main(String[] args) throws FileNotFoundException, UnsupportedEncodingException { - if (args.length == 2 && args[0].equals("--generate-asciidoc")) { - new ConfigurationDocGen(new PrintStream(args[1], UTF_8.name())).generateAsciidoc(); + if (args.length == 2 && args[0].equals("--generate-markdown")) { + new ConfigurationDocGen(new PrintStream(args[1], UTF_8.name())).generateMarkdown(); } else { - throw new IllegalArgumentException("Usage: " + ConfigurationDocGen.class.getName() + " --generate-asciidoc <filename>"); + throw new IllegalArgumentException("Usage: " + ConfigurationDocGen.class.getName() + " --generate-markdown <filename>"); } } } http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/core/src/main/java/org/apache/accumulo/core/conf/Property.java ---------------------------------------------------------------------- diff --git a/core/src/main/java/org/apache/accumulo/core/conf/Property.java b/core/src/main/java/org/apache/accumulo/core/conf/Property.java index 5480867..f22e011 100644 --- a/core/src/main/java/org/apache/accumulo/core/conf/Property.java +++ b/core/src/main/java/org/apache/accumulo/core/conf/Property.java @@ -86,7 +86,7 @@ public enum Property { + "the configuration file, set this property to true."), // SSL properties local to each node (see also instance.ssl.enabled which must be consistent across all nodes in an instance) RPC_PREFIX("rpc.", null, PropertyType.PREFIX, "Properties in this category related to the configuration of SSL keys for RPC. See also instance.ssl.enabled"), - RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH, "Path of the keystore file for the servers' priva:q" + "te SSL key"), + RPC_SSL_KEYSTORE_PATH("rpc.javax.net.ssl.keyStore", "", PropertyType.PATH, "Path of the keystore file for the server's private SSL key"), @Sensitive RPC_SSL_KEYSTORE_PASSWORD("rpc.javax.net.ssl.keyStorePassword", "", PropertyType.STRING, "Password used to encrypt the SSL private keystore. Leave blank to use the Accumulo instance secret"), http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/core/src/main/resources/org/apache/accumulo/core/conf/config-header.txt ---------------------------------------------------------------------- diff --git a/core/src/main/resources/org/apache/accumulo/core/conf/config-header.txt b/core/src/main/resources/org/apache/accumulo/core/conf/config-header.txt deleted file mode 100644 index be1958f..0000000 --- a/core/src/main/resources/org/apache/accumulo/core/conf/config-header.txt +++ /dev/null @@ -1,102 +0,0 @@ -// Licensed to the Apache Software Foundation (ASF) under one or more -// contributor license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright ownership. -// The ASF licenses this file to You under the Apache License, Version 2.0 -// (the "License"); you may not use this file except in compliance with -// the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -[[configuration]] -== Configuration Management - -=== Configuration Overview - -All accumulo properties have a default value in the source code. Properties can also be set -in accumulo-site.xml and in zookeeper on per-table or system-wide basis. If properties are set in more than one location, -accumulo will choose the property with the highest precedence. This order of precedence is described -below (from highest to lowest): - -==== Zookeeper table properties -Table properties are applied to the entire cluster when set in zookeeper using the accumulo API or shell. While table properties take precedent over system properties, both will override properties set in accumulo-site.xml - -Table properties consist of all properties with the table.* prefix. Table properties are configured on a per-table basis using the following shell commmand: - - config -t TABLE -s PROPERTY=VALUE - -==== Zookeeper system properties - -System properties are applied to the entire cluster when set in zookeeper using the accumulo API or shell. System properties consist of all properties with a `yes` in the _Zookeeper Mutable_ column in the table below. They are set with the following shell command: - - config -s PROPERTY=VALUE - -If a table.* property is set using this method, the value will apply to all tables except those configured on per-table basis (which have higher precedence). - -While most system properties take effect immediately, some require a restart of the process which is indicated in _Zookeeper Mutable_. - -==== accumulo-site.xml - -Accumulo processes (master, tserver, etc) read their local accumulo-site.xml on start up. Therefore, changes made to accumulo-site.xml must rsynced across the cluster and processes must be restarted to apply changes. - -Certain properties (indicated by a `no` in _Zookeeper Mutable_) cannot be set in zookeeper and only set in this file. The accumulo-site.xml also allows you to configure tablet servers with different settings. - -==== Default Values - -All properties have a default value in the source code. This value has the lowest precedence and is overriden if set in accumulo-site.xml or zookeeper. - -While the default value is usually optimal, there are cases where a change can increase query and ingest performance. - -==== ZooKeeper Property Considerations - -Any properties that are stored in ZooKeeper should consider the limitations of ZooKeeper itself with respect to the -number of nodes and the size of the node data. Custom table properties and options for Iterators configured on tables -are two areas in which there aren't any failsafes built into the API that can prevent the user from making this mistake. - -While these properties have the ability to add some much needed dynamic configuration tools, use cases which might fall -into these warnings should be reconsidered. - -=== Configuration in the Shell - -The `config` command in the shell allows you to view the current system configuration. You can also use the `-t` option to view a table's configuration as below: - ----- -$ ./bin/accumulo shell -u root -Enter current password for 'root'@'accumulo-instance': ****** - -Shell - Apache Accumulo Interactive Shell -- -- version: 1.6.0 -- instance name: accumulo-instance -- instance id: 4f48fa03-f692-43ce-ae03-94c9ea8b7181 -- -- type 'help' for a list of available commands -- -root@accumulo-instance> config -t foo ----------+---------------------------------------------+------------------------------------------------------ -SCOPE | NAME | VALUE ----------+---------------------------------------------+------------------------------------------------------ -default | table.balancer ............................ | org.apache.accumulo.server.master.balancer.DefaultLoadBalancer -default | table.bloom.enabled ....................... | false -default | table.bloom.error.rate .................... | 0.5% -default | table.bloom.hash.type ..................... | murmur -default | table.bloom.key.functor ................... | org.apache.accumulo.core.file.keyfunctor.RowFunctor -default | table.bloom.load.threshold ................ | 1 -default | table.bloom.size .......................... | 1048576 -default | table.cache.block.enable .................. | false -default | table.cache.index.enable .................. | false -default | table.compaction.major.everything.at ...... | 19700101000000GMT -default | table.compaction.major.everything.idle .... | 1h -default | table.compaction.major.ratio .............. | 1.3 -site | @override .............................. | 1.4 -system | @override .............................. | 1.5 -table | @override .............................. | 1.6 -default | table.compaction.minor.idle ............... | 5m -default | table.compaction.minor.logs.threshold ..... | 3 -default | table.failures.ignore ..................... | false ----- http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/docs/.gitignore ---------------------------------------------------------------------- diff --git a/docs/.gitignore b/docs/.gitignore deleted file mode 100644 index e77a822..0000000 --- a/docs/.gitignore +++ /dev/null @@ -1,28 +0,0 @@ -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# Maven ignores -/target/ - -# IDE ignores -/.settings/ -/.project -/.classpath -/.pydevproject -/.idea -/*.iml -/nbproject/ -/nbactions.xml -/nb-configuration.xml http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/docs/pom.xml ---------------------------------------------------------------------- diff --git a/docs/pom.xml b/docs/pom.xml deleted file mode 100644 index d6a5aaa..0000000 --- a/docs/pom.xml +++ /dev/null @@ -1,144 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - <modelVersion>4.0.0</modelVersion> - <parent> - <groupId>org.apache.accumulo</groupId> - <artifactId>accumulo-project</artifactId> - <version>2.0.0-SNAPSHOT</version> - </parent> - <artifactId>accumulo-docs</artifactId> - <packaging>pom</packaging> - <name>Apache Accumulo Documentation</name> - <description>User documentation for Apache Accumulo.</description> - <dependencies> - <dependency> - <groupId>org.apache.accumulo</groupId> - <artifactId>accumulo-core</artifactId> - <optional>true</optional> - </dependency> - </dependencies> - <build> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-resources-plugin</artifactId> - <executions> - <execution> - <id>copy-asciidoc</id> - <goals> - <goal>copy-resources</goal> - </goals> - <phase>compile</phase> - <configuration> - <outputDirectory>${project.build.directory}/asciidoc</outputDirectory> - <escapeString>\</escapeString> - <useDefaultDelimiters>false</useDefaultDelimiters> - <delimiters> - <delimiter>${*}</delimiter> - </delimiters> - <resources> - <resource> - <directory>src/main/asciidoc</directory> - <filtering>true</filtering> - </resource> - </resources> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> - <configuration> - <backend>html</backend> - <doctype>book</doctype> - <embedAssets>true</embedAssets> - <imagesDir>${project.build.directory}/asciidoc/images</imagesDir> - <sourceDirectory>${project.build.directory}/asciidoc</sourceDirectory> - <sourceHighlighter>highlightjs</sourceHighlighter> - </configuration> - <executions> - <execution> - <id>output-html</id> - <goals> - <goal>process-asciidoc</goal> - </goals> - <phase>prepare-package</phase> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>exec-maven-plugin</artifactId> - <executions> - <execution> - <id>prep-output-dir</id> - <goals> - <goal>exec</goal> - </goals> - <phase>compile</phase> - <configuration> - <executable>mkdir</executable> - <arguments> - <argument>-p</argument> - <argument>${project.build.directory}/asciidoc/appendices</argument> - </arguments> - </configuration> - </execution> - <execution> - <id>config-appendix</id> - <goals> - <goal>java</goal> - </goals> - <phase>compile</phase> - <configuration> - <mainClass>org.apache.accumulo.core.conf.ConfigurationDocGen</mainClass> - <classpathScope>compile</classpathScope> - <arguments> - <argument>--generate-asciidoc</argument> - <argument>${project.build.directory}/asciidoc/appendices/config.txt</argument> - </arguments> - </configuration> - </execution> - </executions> - </plugin> - <plugin> - <groupId>org.codehaus.mojo</groupId> - <artifactId>build-helper-maven-plugin</artifactId> - <executions> - <execution> - <id>attach-user-manual-html</id> - <goals> - <goal>attach-artifact</goal> - </goals> - <configuration> - <artifacts> - <artifact> - <file>${project.build.directory}/generated-docs/accumulo_user_manual.html</file> - <type>html</type> - <classifier>user-manual</classifier> - </artifact> - </artifacts> - </configuration> - </execution> - </executions> - </plugin> - </plugins> - </build> -</project> http://git-wip-us.apache.org/repos/asf/accumulo/blob/e99ec9f0/docs/src/main/asciidoc/accumulo_user_manual.asciidoc ---------------------------------------------------------------------- diff --git a/docs/src/main/asciidoc/accumulo_user_manual.asciidoc b/docs/src/main/asciidoc/accumulo_user_manual.asciidoc deleted file mode 100644 index 2bb2014..0000000 --- a/docs/src/main/asciidoc/accumulo_user_manual.asciidoc +++ /dev/null @@ -1,76 +0,0 @@ -// Licensed to the Apache Software Foundation (ASF) under one or more -// contributor license agreements. See the NOTICE file distributed with -// this work for additional information regarding copyright ownership. -// The ASF licenses this file to You under the Apache License, Version 2.0 -// (the "License"); you may not use this file except in compliance with -// the License. You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. - -Apache Accumulo® User Manual Version ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} -======================================= -:author: Apache Accumulo Project -:email: d...@accumulo.apache.org -:toc2: -:toclevels: 2 -:toc-title: Apache Accumulo ${parsedVersion.majorVersion}.${parsedVersion.minorVersion} -:numbered: -:website: https://accumulo.apache.org/ - -image::accumulo-logo.png[] - -Copyright © 2011-2017 The Apache Software Foundation, Licensed under the Apache -License, Version 2.0. Apache Accumulo, Accumulo, Apache, and the Apache -Accumulo project logo are trademarks of the Apache Software Foundation. - -include::chapters/introduction.txt[] - -include::chapters/design.txt[] - -include::chapters/shell.txt[] - -include::chapters/clients.txt[] - -include::chapters/development_clients.txt[] - -include::chapters/table_configuration.txt[] - -include::chapters/iterator_design.txt[] - -include::chapters/iterator_test_harness.txt[] - -include::chapters/table_design.txt[] - -include::chapters/high_speed_ingest.txt[] - -include::chapters/analytics.txt[] - -include::chapters/security.txt[] - -include::chapters/replication.txt[] - -include::chapters/implementation.txt[] - -include::chapters/ssl.txt[] - -include::chapters/kerberos.txt[] - -include::chapters/sampling.txt[] - -include::chapters/summaries.txt[] - -include::chapters/administration.txt[] - -include::chapters/multivolume.txt[] - -include::chapters/troubleshooting.txt[] - -[appendix] -include::appendices/config.txt[] -
