Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/geode 2015 #267

Closed

Conversation

joeymcallister
Copy link
Contributor

Changes to docs and site directories for adding the documentation/user guide to the Geode website.

@upthewaterspout
Copy link
Contributor

Changes look good. I think there needs to be some changes to geode-site/website/README.md to instruct people to build the docs and include them in the website though. Otherwise someone might build and push the website with the docs missing.

@joeymcallister
Copy link
Contributor Author

Agreed. Working on that now. Thanks!

@davebarnes97
Copy link
Contributor

Pulled & tested. I was especially concerned about the change in redirects from ../doc to ../guide. Local bookbinder bind works. Bookbinder 'watch', which worked for me before, throws errors from various Ruby gems. Not sure that support for bookbinder 'watch' is important, so maybe this doesn't matter. Sample of errors:

$ bundle exec bookbinder watch
Gathering geode-docs
copying /Users/dbarnes/Repo/incubator-geode/geode-docs

Running middleman...

== The Middleman is loading
== LiveReload accepting connections from ws://192.168.1.80:35729
E, [2016-10-21T11:30:42.281013 #71727] ERROR -- : exception while processing events: Is a directory @ io_fread - /Users/dbarnes/Repo/incubator-geode/geode-book/output/master_middleman/source/guide Backtrace:

-- /Users/dbarnes/.rvm/gems/ruby-2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:70:in `read'

-- /Users/dbarnes/.rvm/gems/ruby-2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:70:in `file_contents_include_binary_bytes?'

-- /Users/dbarnes/.rvm/gems/ruby-2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:38:in `binary?'

-- /Users/dbarnes/.rvm/gems/ruby-2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/resource.rb:175:in `binary?'

...and so on.

@davebarnes97
Copy link
Contributor

Correction - bookbinder watch did not work reliably for me, so this PR does not introduce a new problem.
Re-verified that local bind yields good output.

IMO, OK to accept this PR.

@karensmolermiller
Copy link
Contributor

+1 on this PR with two minor alterations in the geode-book/README.md file:

  • the markdown is not quite right. Adding appropriate blank lines and indenting the fixed width text sections by 4 spaces will make the last section's 4 numbered items appear as 1, 2, 3, 4. They currently appear as 1, 1, 1, 1.
  • the first of the 3 commands to embed the User Guide into the website content (what will be step number 2) is missing a period at the end of the command.
    The incorrect commands:
   $ tar cvf ~/Desktop/new-guide-content.tar
   $ cd ../../../geode-site/content
   $ tar xvf ~/Desktop/new-guide-content.tar

The correct commands are

   $ tar cvf ~/Desktop/new-guide-content.tar .
   $ cd ../../../geode-site/content
   $ tar xvf ~/Desktop/new-guide-content.tar

Note: when merging in this PR to a current develop branch, there will be a conflict (as noted in the PR) on the subnav. Keep the develop branch's (new) link to the Automated Rebalance section, but update its path to include /guide.

@joeymcallister
Copy link
Contributor Author

@karensmolermiller I committed a new README.md file with the two changes you suggested. My markdown editors showed the correct formatting before the changes, as well as after the changes. Please review to make sure they're registering in your markdown editor.

@asfgit asfgit closed this in a48871e Oct 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants