Skip to content

Commit 57475bd

Browse files
jknostman3jknostman3
committed
moved the partner template to the new AppDynamics repo for the docs revamp
0 parents  commit 57475bd

File tree

135 files changed

+66319
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+66319
-0
lines changed

Diff for: ‎Gemfile

Whitespace-only changes.

Diff for: ‎README.md

+163
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,163 @@
1+
## Pivotal Cloud Foundry Partners Template
2+
3+
This template helps partners prepare documentation for Pivotal Cloud Foundry (PCF) partner services that appear on [Pivotal Network](https://network.pivotal.io/).
4+
5+
### <a id='overview'></a>Overview
6+
7+
Every partner service in PCF is documented on our PCF documentation site. The links to these partner service docs appear on the [front page](http://docs.pivotal.io) under **Partner Services for Pivotal Cloud Foundry**.
8+
9+
For a good example of a partner service doc, see [MongoDB Enterprise Service for PCF](https://docs.pivotal.io/partners/mongodb/index.html).
10+
11+
### <a id='template'></a>How To Use This Template
12+
13+
Partners use this template to develop the documentation for their PCF service. This repo currently includes templates for the following topics:
14+
15+
* [index.html.md.erb](./docs-content/index.html.md.erb): The index of your docs.
16+
* [installing.html.md.erb](./docs-content/installing.html.md.erb): How to install and configure your product tile.
17+
* [using.html.md.erb](./docs-content/using.html.md.erb): How to use your product.
18+
* [release-notes.html.md.erb](./docs-content/release-notes.html.md.erb): Release notes for your product.
19+
20+
To begin using this repo to develop your documentation, perform the following steps:
21+
22+
1. Make a fork of this repo.
23+
1. Clone your fork onto your local machine.
24+
1. Work your way through each topic, replacing the placeholders in ALL-CAPS and following the instructions in **bold**.
25+
* When writing your documentation, follow the guidelines in [Style Notes for Tile Authors](style-guide.md).
26+
1. 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.
27+
1. View your documentation as a live local site in a browser, by following the steps below in the [How To Use Bookbinder To View Your Docs](#bookbinder) section.
28+
1. When you've finished your documentation, make a pull request to merge your fork into this repo and email the PCF Docs Team at [email protected].
29+
30+
### <a id='bookbinder'></a>How To Use Bookbinder To View Your Docs
31+
32+
[Bookbinder](https://github.com/pivotal-cf/bookbinder/blob/master/README.md) is a command-line utility for stitching Markdown docs into a hostable web app. The PCF Docs Team uses Bookbinder to publish our docs site, but you can also use Bookbinder to view a live version of your documentation on your local machine.
33+
34+
Bookbinder draws the content for the site from `docs-content`, the subnav from `docs-book`, and various layout configuration and assets from `docs-layout`.
35+
36+
To use Bookbinder to view your documentation, perform the following steps:
37+
38+
1. Install Bookbinder by running `gem install bookbindery`. If you have trouble, consult the [Zero to Bookbinder](#zero-to-bookbinder) section to make sure you have the correct dependencies installed.
39+
1. On your local machine, `cd` into `docs-book` in the cloned repo.
40+
1. Run `bundle install` to make sure you have all the necessary gems installed.
41+
1. Build your documentation site with `bookbinder` in one of the two following ways:
42+
* Run `bundle exec bookbinder watch` to build an interactive version of the docs and navigate to `localhost:4567/myservice/` in a browser. (It may take a moment for the site to load at first.) This builds a site from your content repo at `docs-content`, and then watches that repo to update the site if you make any changes to the repo.
43+
* Run `bundle exec bookbinder bind local` to build a Rack web-app of the book. After the bind has completed, `cd` into the `final_app` directory and run `rackup`. Then navigate to `localhost:9292/myservice/` in a browser.
44+
45+
### <a id='zero-to-bookbinder'></a>Zero to Bookbinder: How to Install Bookbinder and Build, View, and Edit Your Docs from Nothing
46+
47+
If you are reading this, Pivotal has invited you to a git repo where you can build and edit documentation in the Ruby / Markdown / HTML format that the online publishing tool [Bookbinder](https://github.com/pivotal-cf/bookbinder/blob/master/README.md) uses to build Pivotal's documentation.
48+
49+
Here's how to install Bookbinder and build your docs from the repo, starting from scratch, on a Mac OS X machine.
50+
51+
<p class="note"><strong>Note</strong>: All steps below are implicitly preceded with, "If you haven't already..." You should skip any installation steps that have already contributed to your environment.</p>
52+
53+
#### Install Ruby
54+
55+
In Terminal window:
56+
57+
1. Make and `cd` into a workspace directory.
58+
59+
`$ mkdir workspace`
60+
61+
`$ cd workspace`
62+
63+
1. Follow the instructions at `http://brew.sh` to install brew / homebrew
64+
65+
`$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
66+
67+
1. Install your own (non-system) ruby.
68+
69+
`$ brew install ruby`
70+
71+
#### Set up Git
72+
73+
1. Download and Install git by following the instructions at [git-scm.com](https://git-scm.com/download/).
74+
75+
1. Install your own (non-system) bash-completion (optional).
76+
77+
`$ brew install git bash-completion`
78+
79+
1. If you don't already have one, generate a public/private RSA key pair, and save the key to your `~/.ssh` directory.
80+
```
81+
$ ssh-keygen
82+
Generating public/private rsa key pair.
83+
Enter file in which to save the key (/Users/pspinrad/.ssh/id_rsa):
84+
```
85+
86+
1. Get a [Github](http://github.com) account.
87+
88+
1. Add your RSA public key to your Github account / profile page.
89+
90+
`$ cat ~/.ssh/id_rsa.pub # copy and paste this into Github profile page as new key`
91+
92+
#### Get the Correct Ruby Version for Bookbinder: Ruby 2.3.0
93+
94+
1. Install a Ruby manager such as chruby.
95+
96+
`$ brew install chruby`
97+
98+
1. Add your Ruby manager to your `~/.bashrc` by appending the following line:
99+
100+
`source /usr/local/opt/chruby/share/chruby/chruby.sh`
101+
102+
1. Install the `ruby-install` installer.
103+
104+
`$ brew install ruby-install`
105+
106+
1. Run `ruby-install` to install Ruby 2.3.0.
107+
108+
`$ ruby-install ruby 2.3.0`
109+
110+
1. Select the following Ruby version.
111+
112+
`chruby ruby-2.3.0`
113+
114+
#### Install Bookbinder
115+
116+
1. Install `bundler`.
117+
118+
`$ gem install bundler`
119+
120+
1. Install bookbinder (the `bookbindery` gem).
121+
122+
`$ gem install bookbindery`
123+
124+
#### Build the Docs Locally
125+
126+
1. Clone the docs template repo you will be building from.
127+
128+
`$ git clone [email protected]:pivotal-cf/docs-partners-template`
129+
130+
1. `cd` into the `book` subdirectory of the repo.
131+
132+
`$ cd docs-partners-template/docs-book`
133+
134+
1. Run `bundle install` to install all book dependencies.
135+
136+
`$ bundle install`
137+
138+
1. Run `bundle exec bookbinder watch` to build the book on your machine.
139+
140+
`$ bundle exec bookbinder watch`
141+
142+
1. Browse to `localhost:4567` to view the book locally and "watch" any changes that you make to source `html.md.erb` files. As you make and save changes to the local source files for your site, you will see them in your browser after a slight delay.
143+
144+
1. After each session of writing or revising your docs source files, commit and push them to your github repo.
145+
146+
### About Subnavs of Published Tile Documentation
147+
148+
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
149+
150+
However, you should also continue to maintain the local subnav file so that the subnav looks correct when you or a Pivotal writer builds your documentation locally with bookbinder for review or editing.
151+
152+
To edit a subnav for your tile documentation, follow these steps:
153+
154+
1. Make a pull request against the subnav file in https://github.com/pivotal-cf/docs-book-partners/tree/master/master_middleman/source/subnavs
155+
156+
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.
157+
158+
Happy documenting!
159+
160+
![Partner Template landing page](./docs-book/master_middleman/source/images/partner-template-landing.png)
161+
162+
![Partner Template service index page](./docs-book/master_middleman/source/images/partner-template-service-index.png)
163+

Diff for: ‎docs-book/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/docs-book/output

Diff for: ‎docs-book/Gemfile

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
source "https://rubygems.org"
2+
3+
gem "bookbindery"

Diff for: ‎docs-book/Gemfile.lock

+204
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,204 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (4.2.10)
5+
i18n (~> 0.7)
6+
minitest (~> 5.1)
7+
thread_safe (~> 0.3, >= 0.3.4)
8+
tzinfo (~> 1.1)
9+
addressable (2.5.2)
10+
public_suffix (>= 2.0.2, < 4.0)
11+
ansi (1.5.0)
12+
backports (3.11.3)
13+
bookbindery (10.1.14)
14+
ansi (~> 1.4)
15+
css_parser
16+
elasticsearch
17+
fog-aws (~> 0.7.1)
18+
font-awesome-sass (= 4.7.0)
19+
git (~> 1.2.8)
20+
middleman (= 4.1.10)
21+
middleman-compass
22+
middleman-livereload
23+
middleman-sprockets
24+
middleman-syntax (= 2.1.0)
25+
nokogiri (= 1.8.2)
26+
puma
27+
rack-rewrite
28+
redcarpet (~> 3.2.3)
29+
rouge (!= 1.9.1)
30+
therubyracer
31+
thor (= 0.19.1)
32+
builder (3.2.3)
33+
chunky_png (1.3.10)
34+
coffee-script (2.4.1)
35+
coffee-script-source
36+
execjs
37+
coffee-script-source (1.12.2)
38+
compass (1.0.3)
39+
chunky_png (~> 1.2)
40+
compass-core (~> 1.0.2)
41+
compass-import-once (~> 1.0.5)
42+
rb-fsevent (>= 0.9.3)
43+
rb-inotify (>= 0.9)
44+
sass (>= 3.3.13, < 3.5)
45+
compass-core (1.0.3)
46+
multi_json (~> 1.0)
47+
sass (>= 3.3.0, < 3.5)
48+
compass-import-once (1.0.5)
49+
sass (>= 3.2, < 3.5)
50+
concurrent-ruby (1.0.5)
51+
contracts (0.13.0)
52+
css_parser (1.6.0)
53+
addressable
54+
dotenv (2.4.0)
55+
elasticsearch (6.1.0)
56+
elasticsearch-api (= 6.1.0)
57+
elasticsearch-transport (= 6.1.0)
58+
elasticsearch-api (6.1.0)
59+
multi_json
60+
elasticsearch-transport (6.1.0)
61+
faraday
62+
multi_json
63+
em-websocket (0.5.1)
64+
eventmachine (>= 0.12.9)
65+
http_parser.rb (~> 0.6.0)
66+
erubis (2.7.0)
67+
eventmachine (1.2.7)
68+
excon (0.62.0)
69+
execjs (2.7.0)
70+
faraday (0.15.2)
71+
multipart-post (>= 1.2, < 3)
72+
fast_blank (1.0.0)
73+
fastimage (2.1.3)
74+
ffi (1.9.25)
75+
fog-aws (0.7.6)
76+
fog-core (~> 1.27)
77+
fog-json (~> 1.0)
78+
fog-xml (~> 0.1)
79+
ipaddress (~> 0.8)
80+
fog-core (1.45.0)
81+
builder
82+
excon (~> 0.58)
83+
formatador (~> 0.2)
84+
fog-json (1.0.2)
85+
fog-core (~> 1.0)
86+
multi_json (~> 1.10)
87+
fog-xml (0.1.3)
88+
fog-core
89+
nokogiri (>= 1.5.11, < 2.0.0)
90+
font-awesome-sass (4.7.0)
91+
sass (>= 3.2)
92+
formatador (0.2.5)
93+
git (1.2.9.1)
94+
haml (5.0.4)
95+
temple (>= 0.8.0)
96+
tilt
97+
hamster (3.0.0)
98+
concurrent-ruby (~> 1.0)
99+
hashie (3.5.7)
100+
http_parser.rb (0.6.0)
101+
i18n (0.7.0)
102+
ipaddress (0.8.3)
103+
kramdown (1.17.0)
104+
libv8 (3.16.14.19)
105+
listen (3.0.8)
106+
rb-fsevent (~> 0.9, >= 0.9.4)
107+
rb-inotify (~> 0.9, >= 0.9.7)
108+
memoist (0.16.0)
109+
middleman (4.1.10)
110+
coffee-script (~> 2.2)
111+
compass-import-once (= 1.0.5)
112+
haml (>= 4.0.5)
113+
kramdown (~> 1.2)
114+
middleman-cli (= 4.1.10)
115+
middleman-core (= 4.1.10)
116+
sass (>= 3.4.0, < 4.0)
117+
middleman-cli (4.1.10)
118+
thor (>= 0.17.0, < 2.0)
119+
middleman-compass (4.0.1)
120+
compass (>= 1.0.0, < 2.0.0)
121+
middleman-core (>= 4.0.0)
122+
middleman-core (4.1.10)
123+
activesupport (~> 4.2)
124+
addressable (~> 2.3)
125+
backports (~> 3.6)
126+
bundler (~> 1.1)
127+
contracts (~> 0.13.0)
128+
dotenv
129+
erubis
130+
execjs (~> 2.0)
131+
fast_blank
132+
fastimage (~> 2.0)
133+
hamster (~> 3.0)
134+
hashie (~> 3.4)
135+
i18n (~> 0.7.0)
136+
listen (~> 3.0.0)
137+
memoist (~> 0.14)
138+
padrino-helpers (~> 0.13.0)
139+
parallel
140+
rack (>= 1.4.5, < 2.0)
141+
sass (>= 3.4)
142+
servolux
143+
tilt (~> 1.4.1)
144+
uglifier (~> 3.0)
145+
middleman-livereload (3.4.6)
146+
em-websocket (~> 0.5.1)
147+
middleman-core (>= 3.3)
148+
rack-livereload (~> 0.3.15)
149+
middleman-sprockets (4.1.1)
150+
middleman-core (~> 4.0)
151+
sprockets (>= 3.0)
152+
middleman-syntax (2.1.0)
153+
middleman-core (>= 3.2)
154+
rouge (~> 1.0)
155+
mini_portile2 (2.3.0)
156+
minitest (5.11.3)
157+
multi_json (1.13.1)
158+
multipart-post (2.0.0)
159+
nokogiri (1.8.2)
160+
mini_portile2 (~> 2.3.0)
161+
padrino-helpers (0.13.3.4)
162+
i18n (~> 0.6, >= 0.6.7)
163+
padrino-support (= 0.13.3.4)
164+
tilt (>= 1.4.1, < 3)
165+
padrino-support (0.13.3.4)
166+
activesupport (>= 3.1)
167+
parallel (1.12.1)
168+
public_suffix (3.0.2)
169+
puma (3.11.4)
170+
rack (1.6.10)
171+
rack-livereload (0.3.17)
172+
rack
173+
rack-rewrite (1.5.1)
174+
rb-fsevent (0.10.3)
175+
rb-inotify (0.9.10)
176+
ffi (>= 0.5.0, < 2)
177+
redcarpet (3.2.3)
178+
ref (2.0.0)
179+
rouge (1.11.1)
180+
sass (3.4.25)
181+
servolux (0.13.0)
182+
sprockets (3.7.1)
183+
concurrent-ruby (~> 1.0)
184+
rack (> 1, < 3)
185+
temple (0.8.0)
186+
therubyracer (0.12.3)
187+
libv8 (~> 3.16.14.15)
188+
ref
189+
thor (0.19.1)
190+
thread_safe (0.3.6)
191+
tilt (1.4.1)
192+
tzinfo (1.2.5)
193+
thread_safe (~> 0.1)
194+
uglifier (3.2.0)
195+
execjs (>= 0.3.0, < 3)
196+
197+
PLATFORMS
198+
ruby
199+
200+
DEPENDENCIES
201+
bookbindery
202+
203+
BUNDLED WITH
204+
1.16.1

Diff for: ‎docs-book/bin/bookbinder

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/usr/bin/env ruby
2+
# frozen_string_literal: true
3+
#
4+
# This file was generated by Bundler.
5+
#
6+
# The application 'bookbinder' is installed as part of a gem, and
7+
# this file is here to facilitate running it.
8+
#
9+
10+
require "pathname"
11+
ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
12+
Pathname.new(__FILE__).realpath)
13+
14+
require "rubygems"
15+
require "bundler/setup"
16+
17+
load Gem.bin_path("bookbindery", "bookbinder")

0 commit comments

Comments
 (0)