You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by joeymcallister <gi...@git.apache.org> on 2016/10/13 01:06:25 UTC

[GitHub] incubator-geode pull request #259: Feature/geode 1952 2

GitHub user joeymcallister opened a pull request:

    https://github.com/apache/incubator-geode/pull/259

    Feature/geode 1952 2

    This merges feature/GEODE-1952, which was branched from the
    docs donation staging branch, into feature/GEODE-1952-2, which
    was branched from develop.
    
    In addition to merging the docs donation, it adds the
    geode-book directory for building the end-user documentation
    from the content in the geode-docs directory. It also updates the
    geode-docs README for building the docs locally.

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

    $ git pull https://github.com/joeymcallister/incubator-geode feature/GEODE-1952-2

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

    https://github.com/apache/incubator-geode/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 d9d8b59b325c0581ff54c97db91b52adb0f4714c
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-11T20:34:06Z

    Add geode-book dir for docs build

commit 1c98ba56cf609ee61b5872cd696db95d4bcfebaa
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-11T21:06:36Z

    Revert "Add geode-book dir for docs build"
    
    This reverts commit d9d8b59b325c0581ff54c97db91b52adb0f4714c.

commit e9b44af4e996ac739cd632704e925d525b9fcca1
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-11T21:24:40Z

    GEODE-1952 Add geode-book dir to build docs

commit 7592ba1027e51ae84dcfbed297534522557fbbec
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-11T21:38:11Z

    GEODE-1952 Remove old redirects

commit 36d1f39d68a847dc574e267c51efa89f9c980bd6
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-11T22:54:54Z

    GEODE-1952 Update docs README, config

commit 0b31275966beaf4039afd913b8644c81a32c1758
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-12T00:29:12Z

    GEODE-1952 Add book README; edit docs README, CONTRIBUTE

commit 14a32e2ebaa88726e3d70c9b69c1aacae3f3b4e1
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-12T20:38:00Z

    Edit README; rm pdf_header

commit 98ed943a9ac3a8ab9ff941fd3f1527ebd1600209
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-12T21:41:27Z

    Merge branch 'feature/GEODE-1952' into feature/GEODE-1952-2
    
    GEODE-1952 was branched from the docs donation staging branch.
    This merges docs work from that branch to 1952-2, which is
    branched from develop.

commit dcc9de7702ba0f2de60f1e2983b472b2cf89404d
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-12T21:49:46Z

    Fix README numbering, anchors

commit a5d1e957a825e2d5f76764182f58b9f257730af4
Author: Joey McAllister <jm...@pivotal.io>
Date:   2016-10-13T00:56:09Z

    GEODE-1952: Change Project G to Apache G; other edits

----


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Re: [GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by Joey McAllister <jm...@pivotal.io>.
Hi Swapnil,

Yes, I'm working on that right now and will resubmit.

Joey

On Thu, Oct 13, 2016 at 1:40 PM sbawaska <gi...@git.apache.org> wrote:

> Github user sbawaska commented on the issue:
>
>     https://github.com/apache/incubator-geode/pull/259
>
>     Hi @joeymcallister The CI failed because the new files are missing the
> Apache License header. Can you please fix this and re-submit the pull
> request?
>     ```
>     71 Unknown Licenses
>     *******************************
>     Unapproved licenses:
>       /home/travis/build/apache/incubator-geode/geode-book/Gemfile
>       /home/travis/build/apache/incubator-geode/geode-book/Gemfile.lock
>       /home/travis/build/apache/incubator-geode/geode-book/config.yml
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/index.html.erb
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/book.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/context.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/group.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/noframeworkAdapter.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/sticky.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/waypoint.js
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/layouts/_book-footer.erb
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/layouts/_title.erb
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/book-styles.css.scss
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/partials/_book-base-values.scss
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/partials/_book-vars.scss
>
> /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/subnavs/geode-subnav.erb
>       /home/travis/build/apache/incubator-geode/geode-book/redirects.rb
>
> /home/travis/build/apache/incubator-geode/geode-docs/images_svg/JMX_Architecture.svg
>
> /home/travis/build/apache/incubator-geode/geode-docs/images_svg/MBeans.svg
>     ...
>     ```
>
>
> ---
> 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 infrastructure@apache.org or file a JIRA ticket
> with INFRA.
> ---
>

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by sbawaska <gi...@git.apache.org>.
Github user sbawaska commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    Hi @joeymcallister The CI failed because the new files are missing the Apache License header. Can you please fix this and re-submit the pull request?
    ```
    71 Unknown Licenses
    *******************************
    Unapproved licenses:
      /home/travis/build/apache/incubator-geode/geode-book/Gemfile
      /home/travis/build/apache/incubator-geode/geode-book/Gemfile.lock
      /home/travis/build/apache/incubator-geode/geode-book/config.yml
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/index.html.erb
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/book.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/context.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/group.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/noframeworkAdapter.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/sticky.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/javascripts/waypoints/waypoint.js
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/layouts/_book-footer.erb
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/layouts/_title.erb
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/book-styles.css.scss
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/partials/_book-base-values.scss
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/stylesheets/partials/_book-vars.scss
      /home/travis/build/apache/incubator-geode/geode-book/master_middleman/source/subnavs/geode-subnav.erb
      /home/travis/build/apache/incubator-geode/geode-book/redirects.rb
      /home/travis/build/apache/incubator-geode/geode-docs/images_svg/JMX_Architecture.svg
      /home/travis/build/apache/incubator-geode/geode-docs/images_svg/MBeans.svg
    ...
    ```


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by metatype <gi...@git.apache.org>.
Github user metatype commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    LGTM


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    @sbawaska Commit 2b6fec8 corrects the license issues and I was able to build successfully.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    @metatype 
    
    1. Running `bundle install` in the final_app dir isn't something I'm familiar with. We don't usually have to do it, and I'm currently able to build and `rackup` the Geode book without doing that but, well ... who knows what Ruby's doing behind the scenes? (@upthewaterspout Did you happen to encounter this when running through the process the first time?)
    2. I postponed the docs-to-website step in order to focus on getting the docs buildable and licensed. The short version is that you can move the contents of the directory geode-book/final_app/public/docs to the directory geode-site/website/content/docs and then follow the instructions for updating the website located at geode-site/website/README.md. (I need to tweak some stylesheet stuff in geode-site to make the docs display correctly, but that should be a one-time thing.)



---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by metatype <gi...@git.apache.org>.
Github user metatype commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    I think the README could use a few clarifications:
    
    1) You also need to run `bundle install` in the final_app dir.
    2) How do we take the generated html site and merge it into the asf-site branch so it can be hosted on geode.apache.org.
    
    I also ran into some strange ruby errors installing libv8 / therubyracer that required google's help.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by metatype <gi...@git.apache.org>.
Github user metatype commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    Is `geode-book` a generated dir or a source directory?


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode pull request #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on a diff in the pull request:

    https://github.com/apache/incubator-geode/pull/259#discussion_r83350443
  
    --- Diff: geode-docs/README.md ---
    @@ -1,93 +1,53 @@
    -# Project Geode End-User Documentation
    +# Apache Geode End-User Documentation
     
    -The latest check-ins to `project-geode/docs` are automatically built and published to <http://geode-docs.cfapps.io>.
    +Apache Geode provides the full source for end-user documentation in markdown format. The latest check-ins to `incubator-geode/geode-docs` are regularly built and published to http://geode.incubator.apache.org/docs/. Users can build the markdown into an HTML user guide using [Bookbinder](https://github.com/pivotal-cf/bookbinder) and the instructions below.
     
    -Project Geode provides the full source for end-user documentation in markdown format. The markdown can be built into HTML using [Bookbinder](https://github.com/pivotal-cf/bookbinder).
    +Bookbinder is a Ruby gem that binds  a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application.
     
    -Bookbinder is a gem that binds together a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application.
    +This document contains instructions for building and viewing the Geode documentation locally.
     
    -This document contains instructions for building the local Geode documentation and publishing it to Cloud Foundry or Pivotal Web Services. It contains the sections:
    +- [Prerequisites](#prerequisites)
    +- [Bookbinder Usage](#bookbinder-usage)
    +- [Building the Documentation](#building-the-documentation)
     
    -- [Bookbinder Usage](#usage)
    -- [Prerequisites](#prereq)
    -- [Building the Documentation](#building)
    -- [Publishing the Documentation](#publishing)
    -- [Getting More Information](#moreinfo)
    +## Prerequisites
     
    -[]()
    +Bookbinder requires Ruby version 2.0.0-p195 or higher.
     
    -## Bookbinder Usage
    +Follow the instructions below to install Bookbinder:
     
    -Bookbinder is meant to be used from within a project called a **book**. The book includes a configuration file that describes which documentation repositories to use as source materials. Bookbinder provides a set of scripts to aggregate those repositories and publish them to various locations.
    +1. Add gem "bookbindery" to your Gemfile.
    --- End diff --
    
    @upthewaterspout I think you're right: The Gemfile checked into the geode-book directory should already have bookbindery and shouldn't need to be added again.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode pull request #259: Feature/geode 1952 2

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/incubator-geode/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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    @joeymcallister - Ok, the parallel directories makes more sense now. We can always move stuff around after 1.0 if we decide to.
    
    I also had to do bundle install in the final_app directory in order to run rackup. I don't know if we really need to use rackup anyway, this seems like an easier way to quickly view the book:
    ```
    cd final_app/public
    python -m SimpleHTTPServer 8080
    ```


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    +1


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    +1   
    I built with bookbinder and viewed with rackup, per the README.md instructions.
    Running `./gradlew rat` passed the license check:  no licensing issues.



---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    `geode-book` is a source directory containing the pieces (e.g., the
    `config.yml` that points Bookbinder to content, and the `geode-subnav.erb`
    that provides the book's table of contents) that Bookbinder uses to
    generate directories `geode-book/output/` and `geode-book/final_app` from
    the markdown files in `geode-docs`.
    
    On Thu, Oct 13, 2016 at 1:44 PM Anthony Baker <no...@github.com>
    wrote:
    
    Is geode-book a generated dir or a source directory?
    
    \u2014
    You are receiving this because you were mentioned.
    Reply to this email directly, view it on GitHub
    <https://github.com/apache/incubator-geode/pull/259#issuecomment-253633135>,
    or mute the thread
    <https://github.com/notifications/unsubscribe-auth/APXEUTUuhqkV-oHKwTUCuOLUm8zUxP1bks5qzpg7gaJpZM4KVYQ9>
    .



---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode pull request #259: Feature/geode 1952 2

Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on a diff in the pull request:

    https://github.com/apache/incubator-geode/pull/259#discussion_r83334338
  
    --- Diff: geode-docs/README.md ---
    @@ -1,93 +1,53 @@
    -# Project Geode End-User Documentation
    +# Apache Geode End-User Documentation
     
    -The latest check-ins to `project-geode/docs` are automatically built and published to <http://geode-docs.cfapps.io>.
    +Apache Geode provides the full source for end-user documentation in markdown format. The latest check-ins to `incubator-geode/geode-docs` are regularly built and published to http://geode.incubator.apache.org/docs/. Users can build the markdown into an HTML user guide using [Bookbinder](https://github.com/pivotal-cf/bookbinder) and the instructions below.
     
    -Project Geode provides the full source for end-user documentation in markdown format. The markdown can be built into HTML using [Bookbinder](https://github.com/pivotal-cf/bookbinder).
    +Bookbinder is a Ruby gem that binds  a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application.
     
    -Bookbinder is a gem that binds together a unified documentation web application from markdown, html, and/or DITA source material. The source material for bookbinder must be stored either in local directories or in GitHub repositories. Bookbinder runs [middleman](http://middlemanapp.com/) to produce a Rackup app that can be deployed locally or as a Web application.
    +This document contains instructions for building and viewing the Geode documentation locally.
     
    -This document contains instructions for building the local Geode documentation and publishing it to Cloud Foundry or Pivotal Web Services. It contains the sections:
    +- [Prerequisites](#prerequisites)
    +- [Bookbinder Usage](#bookbinder-usage)
    +- [Building the Documentation](#building-the-documentation)
     
    -- [Bookbinder Usage](#usage)
    -- [Prerequisites](#prereq)
    -- [Building the Documentation](#building)
    -- [Publishing the Documentation](#publishing)
    -- [Getting More Information](#moreinfo)
    +## Prerequisites
     
    -[]()
    +Bookbinder requires Ruby version 2.0.0-p195 or higher.
     
    -## Bookbinder Usage
    +Follow the instructions below to install Bookbinder:
     
    -Bookbinder is meant to be used from within a project called a **book**. The book includes a configuration file that describes which documentation repositories to use as source materials. Bookbinder provides a set of scripts to aggregate those repositories and publish them to various locations.
    +1. Add gem "bookbindery" to your Gemfile.
    --- End diff --
    
    Is this step necessary? It seems like the stuff under "Building the Documentation" is sufficient.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by upthewaterspout <gi...@git.apache.org>.
Github user upthewaterspout commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    I think geode-docs should be a subdirectory of geode-book so we don't have two unrelated directories for these docks.
    
    It should probably output to a directory called build to be consistent with the rest of the build.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    Tweaked the build instructions to include `build install` before `rackup`. Also moved the README, which focuses on building the docs, to the `geode-book` dir (and pointed to it from `geode-docs/CONTRIBUTE.md`, which focuses on working with the raw content).
    
    If it's okay with everyone, I'd like to call GEODE-1952 done and revisit any outstanding issues from the thread (e.g., dir structure) in future work/tickets.


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by davebarnes97 <gi...@git.apache.org>.
Github user davebarnes97 commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    +1
    Bookbinder publishing procedure worked for me.



---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    @upthewaterspout:
    
    > Add the final_app and output directories to the rat excludes, so people don't have rat failures after building the docs.
    
    Excellent suggestion. Thank you. \U0001f44d 
    
    > Is there a clean target to remove the docs?
    
    My experience with this has always been with a dedicated docs-book repo, so `git clean` was sufficient. If there's a way to specifically clean only the `geode-book` dir, I'd love to implement 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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

[GitHub] incubator-geode issue #259: Feature/geode 1952 2

Posted by joeymcallister <gi...@git.apache.org>.
Github user joeymcallister commented on the issue:

    https://github.com/apache/incubator-geode/pull/259
  
    @upthewaterspout Bookbinder requires the "book" directory to be at the same dir level as the content, so a subdirectory wouldn't work here. If the goal is to clean up the top level, we could move both of these directories into one directory\u2014perhaps as follows:
    
    - geode-docs
       - geode-docs-book
       - geode-docs-content 


---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---