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

[upthewaterspout]

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

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

[metatype]

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

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

[joeymcallister]

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

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

[upthewaterspout]

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

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

[joeymcallister]

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. 👍 

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

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

[joeymcallister]

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

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

[joeymcallister]

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

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

[upthewaterspout]

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

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

[metatype]

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

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

[karensmolermiller]

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

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

[joeymcallister]

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

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

[davebarnes97]

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

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

[joeymcallister]

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 
wrote:

Is geode-book a generated dir or a source directory?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
,
or mute the thread


.



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

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

[metatype]

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

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

[Joey McAllister]

Hi Swapnil,

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

Joey

On Thu, Oct 13, 2016 at 1:40 PM sbawaska  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 infrastruct...@apache.org or file a JIRA ticket
> with INFRA.
> ---
>

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

[sbawaska]

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