Application Cloud Documentation

This project publishes the App Cloud documentation as a web application.

These docs can be reached at https://docs.developer.swisscom.com

What's in this Repository

This repo uses the Bookbindery gem to generate the documentation as a web application.

The config.yml file contains the list of topic repositories.

The master_middleman folder contains the template used for publishing

This repository does not contain the documentation content. That's contained in the topic repositories listed in the config.yml.

Topic Repositories

The topic repositories that make up the App Cloud documentation set are:

• Cloud Foundry Concepts: a guide to the underlying concepts and architecture.
• Developer Guide: step-by-step instructions and reference material for developers pushing applications to Cloud Foundry.
• CF CLI: a guide to using the Cloud Foundry CLI.
• Administrator Tools: documentation about how to operate Cloud Foundry deployments using bosh and cf command line tools.
• Services: information about extending Cloud Foundry with custom services, and the service broker API.
• Running Cloud Foundry: information for operators running Cloud Foundry.
• Buildpacks: a guide to developing your own buildpacks.
• Getting Started: a guide for new users on how to get started with the App Cloud
• Web Console: a guide about using the web console on https://developer.swisscom.com
• Apps: a guide about apps
• Service Offerings: a list of the different service offerings of Swisscom
• Billing: shows how billing in the app cloud works and makes it more transparent for users
• API: a guide on how to use the Swisscom APIs

Build

Setup

1. Run bundle install

Bind

1. Run bundle exec bookbinder bind remote

Run locally

1. Build the docs
2. Run cd final_app
3. Run rackup
4. Open your web browser at the specified URL

ref: '225' refers to the 225 branch of the docs-cloudfoundry-concepts repo. Cloud Foundry 225 is associated with v255 of cf-release. 1.5, 2.2 and 4.5 map to cf-deployment releases.

1. Set environment variables required in respective deployment script (see ci/scripts folder)
2. Run ci/scripts/cf-deploy.dev.sh or ci/scripts/cf-deploy.prd.sh