pivotal-cf / docs-partners-template

This repo currently includes templates for the following topics:

• index.html.md.erb: The index of your docs.
• installing.html.md.erb: How to install and configure your product tile.
• using.html.md.erb: How to use your product.
• release-notes.html.md.erb: Release notes for your product.

To begin using this repo to develop your documentation, perform the following steps:

1. Make a fork of this repo.
2. Clone your fork onto your local machine.
3. Work your way through each topic, replacing the placeholders in ALL-CAPS and following the instructions in bold.
   • When writing your documentation, follow the guidelines in Style Notes for Tile Authors.
4. Complete the subnav by replacing the placeholders in ALL-CAPS in the subnav file at docs-book/master_middleman/source/subnavs/myservice_subnav.erb in this repo.
5. When you've finished your documentation, make a pull request to merge your fork into this repo and email the ISV team at [email protected].

About Subnavs of Published Tile Documentation

After your tile documentation has been published, the subnav used for the live documentation is contained in this directory: https://github.com/pivotal-cf/docs-book-partners/tree/master/master_middleman/source/subnavs

However, you should also continue to maintain the local subnav file.

To edit a subnav for your tile documentation, follow these steps:

1. Make a pull request against the subnav file in https://github.com/pivotal-cf/docs-book-partners/tree/master/master_middleman/source/subnavs

2. Make the same changes in the subnav file (in /docs-book/master_middleman/source/subnavs/ of your tile repo) and make a pull request for that change too.

Happy documenting!

docs-partners-template's Issues

Exception when using template

Hi,
I tried to use the template today, but I got the following error:

E, [2018-08-16T08:17:26.075840 #2238] ERROR -- : exception while processing events: Is a directory @ io_fread - /path/to/oss/docs-partners-template/docs-book/output/master_middleman/source/myservice Backtrace:

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:70:in `read'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:70:in `file_contents_include_binary_bytes?'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util/binary.rb:38:in `binary?'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/resource.rb:175:in `binary?'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/core_extensions/front_matter.rb:37:in `block in manipulate_resource_list'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/core_extensions/front_matter.rb:36:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/core_extensions/front_matter.rb:36:in `manipulate_resource_list'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/store.rb:234:in `block (4 levels) in ensure_resource_list_updated!'

 -- /Library/Ruby/Gems/2.3.0/gems/activesupport-4.2.10/lib/active_support/notifications.rb:166:in `instrument'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util.rb:21:in `instrument'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/store.rb:232:in `block (3 levels) in ensure_resource_list_updated!'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `traverse_depth_first'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:431:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/store.rb:231:in `block (2 levels) in ensure_resource_list_updated!'

 -- /Library/Ruby/Gems/2.3.0/gems/activesupport-4.2.10/lib/active_support/notifications.rb:166:in `instrument'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/util.rb:21:in `instrument'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/store.rb:224:in `block in ensure_resource_list_updated!'

 -- /System/Library/Frameworks/Ruby.framework/Versions/2.3/usr/lib/ruby/2.3.0/monitor.rb:214:in `mon_synchronize'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/store.rb:221:in `ensure_resource_list_updated!'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sitemap/extensions/on_disk.rb:51:in `update_files'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sources.rb:366:in `block in run_callbacks'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `traverse_depth_first'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:431:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sources.rb:359:in `run_callbacks'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sources.rb:349:in `did_change'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/callback_manager.rb:57:in `instance_exec'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/callback_manager.rb:57:in `block in execute'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:1316:in `traverse_depth_first'

 -- /Library/Ruby/Gems/2.3.0/gems/hamster-3.0.0/lib/hamster/vector.rb:431:in `each'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/callback_manager.rb:57:in `execute'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/callback_manager.rb:28:in `block in install_methods!'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sources/source_watcher.rb:279:in `update'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/middleman-core-4.1.10/lib/middleman-core/sources/source_watcher.rb:243:in `on_listener_change'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_reference.rb:43:in `send_to'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/call_with.rb:76:in `call_with'

 -- /Library/Ruby/Gems/2.3.0/gems/contracts-0.13.0/lib/contracts/method_handler.rb:138:in `block in redefine_method'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/config.rb:23:in `call'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/processor.rb:115:in `_process_changes'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/processor.rb:19:in `block in loop_for'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/processor.rb:15:in `loop'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/processor.rb:15:in `loop_for'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/loop.rb:84:in `_wait_for_changes'

 -- /Library/Ruby/Gems/2.3.0/gems/listen-3.0.8/lib/listen/event/loop.rb:42:in `block in setup'

The webserver is started and the website is rendered, but the watch is not executed, which means the website is not automatically rebuilding after a change. Only restarting bundle exec bookbinder watch leads to a rebuild of the website.

Any idea, what might be wrong?

Please configure GITBOT

@claurence : Pivotal uses GITBOT to synchronize Github issues and pull requests with Pivotal Tracker.
Please add your new repo to the GITBOT config-prouction.yml in the Gitbot configuration repo
If there are any questions, please reach out to [email protected]