pivotal-cf/docs-walkthrough

Name: docs-walkthrough

Owner: Pivotal Cloud Foundry

Description: null

Created: 2017-01-30 19:22:57.0

Updated: 2017-10-18 23:03:23.0

Pushed: 2017-10-24 17:37:46.0

Homepage: null

Size: 1838

Language: HTML

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

docs-walkthrough

This repository contains the content for the the walkthrough documentation, published at https://docs-walkthrough.cfapps.io. The documentation is currently under development.

Once we've made some progress on this, we can integrate it into our other documentation site, like https://docs.pivotal.io/

What We're Doing

We're going to use this repository to develop a document, or maybe a set of documents, that takes customers through the journey of deploying, running, and upgrading a Spring/Java application on the platform using services.

Many of these details already exist in our current documentation or in GitHub repositories, but we're creating this to pull together all the disparate parts to make a walkthrough – step-by-step information to help developers efficiently get on-boarded to using PCF, full of best practices and stuff.

How to Use This

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

  1. Clone this repo onto your local machine.
  2. Add markdown files, or edit existing files – either your own, or ones you pull from other sources like our existing documentation.
  3. Commit your changes to GitHub.

We've set up a Concourse pipeline to automatically put together a website where you can see the changes you've made at https://docs-walkthrough.cfapps.io

It typically takes 2-5 minutes for changes to make it through the pipeline. If you have problems, need help, or just want to chat with a tech writer, contact us at cf-docs@pivotal.io or on the #pcf-docs channel in the Pivotal org on Slack.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.