[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

classic Classic list List threaded Threaded
10 messages Options
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
GitHub user mikewalch opened a pull request:

    https://github.com/apache/accumulo/pull/259

    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
   
    See https://github.com/apache/accumulo-website/pull/11 for corresponding PR to add documentation to website.

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/mikewalch/accumulo remove-docs

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/accumulo/pull/259.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #259
   
----
commit 5ad1e4bb75d0f523a6611bcbe844bb352181f272
Author: Mike Walch <[hidden email]>
Date:   2017-05-17T20:30:35Z

    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

----


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
Github user ctubbsii commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117340009
 
    --- Diff: core/src/main/java/org/apache/accumulo/core/conf/ConfigurationDocGen.java ---
    @@ -37,174 +31,115 @@
     
         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) + " |");
    --- End diff --
   
    Could also make the `**` a `bold(String)`


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user ctubbsii commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117340686
 
    --- Diff: core/src/main/java/org/apache/accumulo/core/conf/Property.java ---
    @@ -86,7 +86,7 @@
               + "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"),
    --- End diff --
   
    Heh, `vi`-based typos. :)


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user keith-turner commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117530055
 
    --- Diff: 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>
    --- End diff --
   
    Will this be used by the website docs?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user keith-turner commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117529957
 
    --- Diff: pom.xml ---
    @@ -257,13 +256,6 @@
           </dependency>
           <dependency>
             <groupId>org.apache.accumulo</groupId>
    -        <artifactId>accumulo-docs</artifactId>
    --- End diff --
   
    There is still asciidoc plugin info in this pom, should that be removed?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user mikewalch commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117531534
 
    --- Diff: 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>
    --- End diff --
   
    Yes, we still need to generate documentation for the configuration properties and copy it to the accumulo website repo.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user mikewalch commented on a diff in the pull request:

    https://github.com/apache/accumulo/pull/259#discussion_r117531617
 
    --- Diff: pom.xml ---
    @@ -257,13 +256,6 @@
           </dependency>
           <dependency>
             <groupId>org.apache.accumulo</groupId>
    -        <artifactId>accumulo-docs</artifactId>
    --- End diff --
   
    It should be removed.  I will push another commit.


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo pull request #259: ACCUMULO-4630 Move user manual to Accumulo websi...

ctubbsii
In reply to this post by ctubbsii
Github user asfgit closed the pull request at:

    https://github.com/apache/accumulo/pull/259


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo issue #259: ACCUMULO-4630 Move user manual to Accumulo website

ctubbsii
In reply to this post by ctubbsii
Github user ctubbsii commented on the issue:

    https://github.com/apache/accumulo/pull/259
 
    The referenced JIRA issue remains open. Is there more work to be done?


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---
Reply | Threaded
Open this post in threaded view
|

[GitHub] accumulo issue #259: ACCUMULO-4630 Move user manual to Accumulo website

ctubbsii
In reply to this post by ctubbsii
Github user mikewalch commented on the issue:

    https://github.com/apache/accumulo/pull/259
 
    I closed it


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.
---