Name: docs-vmware-harbor
Owner: Pivotal Cloud Foundry
Description: null
Created: 2017-11-20 20:10:18.0
Updated: 2018-05-22 01:03:51.0
Pushed: 2018-05-22 01:03:50.0
Homepage: null
Size: 1334
Language: HTML
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
This repo contains the content for the documentation for VMware Harbor Registry.
The content in this repo publishes to the VMWare Harbor Registry documentation site at https://docs.pivotal.io/vmware-harbor.
The subnav for this documentation is located at https://github.com/pivotal-cf/docs-book-partners/blob/master/master_middleman/source/subnavs/vmware-harbor_subnav.erb.
Please help us improve the accuracy and completeness of the VMware Harbor Registry documentation by contributing.
The easiest way to contribute is to file a pull request through GitHub.
Every topic in the VMware Harbor Registry documentation has a corresponding file in this repo. Locate the correct file and make a pull request against it. You can also navigate to the topic and click “View the source for this page in GitHub” at the bottom of the topic.
Bookbinder is a command-line utility for stitching Markdown docs into a hostable web app. The PCF Docs Team uses Bookbinder to publish our documentation sites, but you can also use Bookbinder to view a live version of your documentation on your local machine.
Bookbinder draws the content for the site from this repo, the left navigation menu (“subnav”) from docs-book-partners, and various layout configuration and assets from docs-layout-repo.
To use Bookbinder to view your documentation, perform the following steps:
~/workspace directory on your local machine.docs-book-partners and docs-layout-repo to the ~/workspace directory on your local machine.docs-book-partners directory.bundle install to install all of the necessary gems, including Bookbinder.bookbinder in one of the two following ways: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.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.