diff --git a/.ruby-version b/.ruby-version index a894319c..6e853688 100644 --- a/.ruby-version +++ b/.ruby-version @@ -1,2 +1,2 @@ -2.3.0 +2.5.5 diff --git a/Gemfile b/Gemfile index 2df6704e..23643fea 100644 --- a/Gemfile +++ b/Gemfile @@ -1,6 +1,6 @@ source 'http://rubygems.org' gem 'therubyracer' -gem 'bookbindery', "9.12.0" +gem 'bookbindery', "10.1.15" gem 'rake' gem 'jasmine' gem 'font-awesome-sass', '4.7.0' diff --git a/Gemfile.lock b/Gemfile.lock index 99bb5f4b..cb53c457 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,39 +1,36 @@ GEM remote: http://rubygems.org/ specs: - activesupport (4.2.10) + activesupport (4.2.11.1) i18n (~> 0.7) minitest (~> 5.1) thread_safe (~> 0.3, >= 0.3.4) tzinfo (~> 1.1) - addressable (2.5.2) + addressable (2.6.0) public_suffix (>= 2.0.2, < 4.0) ansi (1.5.0) - bookbindery (9.12.0) + backports (3.14.0) + bookbindery (10.1.15) ansi (~> 1.4) css_parser elasticsearch fog-aws (~> 0.7.1) - font-awesome-sass + font-awesome-sass (= 4.7.0) git (~> 1.2.8) - middleman (~> 3.4.0) - middleman-livereload (~> 3.4.3) - middleman-syntax (~> 2.0) - nokogiri (= 1.6.7.2) + middleman (= 4.1.10) + middleman-compass + middleman-livereload + middleman-sprockets + middleman-syntax (= 2.1.0) + nokogiri (= 1.10.1) puma rack-rewrite redcarpet (~> 3.2.3) rouge (!= 1.9.1) therubyracer - thor + thor (= 0.19.1) builder (3.2.3) - capybara (2.4.4) - mime-types (>= 1.16) - nokogiri (>= 1.3.3) - rack (>= 1.0.0) - rack-test (>= 0.5.4) - xpath (~> 2.0) - chunky_png (1.3.10) + chunky_png (1.3.11) coffee-script (2.4.1) coffee-script-source execjs @@ -50,26 +47,31 @@ GEM sass (>= 3.3.0, < 3.5) compass-import-once (1.0.5) sass (>= 3.2, < 3.5) - css_parser (1.6.0) + concurrent-ruby (1.1.5) + contracts (0.13.0) + css_parser (1.7.0) addressable - elasticsearch (6.0.2) - elasticsearch-api (= 6.0.2) - elasticsearch-transport (= 6.0.2) - elasticsearch-api (6.0.2) + dotenv (2.7.2) + elasticsearch (7.0.0) + elasticsearch-api (= 7.0.0) + elasticsearch-transport (= 7.0.0) + elasticsearch-api (7.0.0) multi_json - elasticsearch-transport (6.0.2) + elasticsearch-transport (7.0.0) faraday multi_json em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) erubis (2.7.0) - eventmachine (1.2.5) - excon (0.62.0) + eventmachine (1.2.7) + excon (0.64.0) execjs (2.7.0) - faraday (0.15.0) + faraday (0.15.4) multipart-post (>= 1.2, < 3) - ffi (1.9.23) + fast_blank (1.0.0) + fastimage (2.1.5) + ffi (1.10.0) fog-aws (0.7.6) fog-core (~> 1.27) fog-json (~> 1.0) @@ -79,8 +81,8 @@ GEM builder excon (~> 0.58) formatador (~> 0.2) - fog-json (1.0.2) - fog-core (~> 1.0) + fog-json (1.2.0) + fog-core multi_json (~> 1.10) fog-xml (0.1.3) fog-core @@ -92,9 +94,9 @@ GEM haml (5.0.4) temple (>= 0.8.0) tilt - hike (1.2.3) - hooks (0.4.1) - uber (~> 0.0.14) + hamster (3.0.0) + concurrent-ruby (~> 1.0) + hashie (3.6.0) http_parser.rb (0.6.0) i18n (0.7.0) ipaddress (0.8.3) @@ -104,114 +106,111 @@ GEM rack (>= 1.2.1) rake jasmine-core (3.1.0) - json (2.1.0) - kramdown (1.16.2) + kramdown (1.17.0) libv8 (3.16.14.19) listen (3.0.8) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - middleman (3.4.1) + memoist (0.16.0) + middleman (4.1.10) coffee-script (~> 2.2) - compass (>= 1.0.0, < 2.0.0) compass-import-once (= 1.0.5) - execjs (~> 2.0) haml (>= 4.0.5) kramdown (~> 1.2) - middleman-core (= 3.4.1) - middleman-sprockets (>= 3.1.2) + middleman-cli (= 4.1.10) + middleman-core (= 4.1.10) sass (>= 3.4.0, < 4.0) - uglifier (~> 2.5) - middleman-core (3.4.1) - activesupport (~> 4.1) + middleman-cli (4.1.10) + thor (>= 0.17.0, < 2.0) + middleman-compass (4.0.1) + compass (>= 1.0.0, < 2.0.0) + middleman-core (>= 4.0.0) + middleman-core (4.1.10) + activesupport (~> 4.2) + addressable (~> 2.3) + backports (~> 3.6) bundler (~> 1.1) - capybara (~> 2.4.4) + contracts (~> 0.13.0) + dotenv erubis - hooks (~> 0.3) + execjs (~> 2.0) + fast_blank + fastimage (~> 2.0) + hamster (~> 3.0) + hashie (~> 3.4) i18n (~> 0.7.0) - listen (~> 3.0.3) - padrino-helpers (~> 0.12.3) + listen (~> 3.0.0) + memoist (~> 0.14) + padrino-helpers (~> 0.13.0) + parallel rack (>= 1.4.5, < 2.0) - thor (>= 0.15.2, < 2.0) - tilt (~> 1.4.1, < 2.0) + sass (>= 3.4) + servolux + tilt (~> 1.4.1) + uglifier (~> 3.0) middleman-livereload (3.4.6) em-websocket (~> 0.5.1) middleman-core (>= 3.3) rack-livereload (~> 0.3.15) - middleman-sprockets (3.5.0) - middleman-core (>= 3.3) - sprockets (~> 2.12.1) - sprockets-helpers (~> 1.1.0) - sprockets-sass (~> 1.3.0) + middleman-sprockets (4.1.1) + middleman-core (~> 4.0) + sprockets (>= 3.0) middleman-syntax (2.1.0) middleman-core (>= 3.2) rouge (~> 1.0) - mime-types (3.1) - mime-types-data (~> 3.2015) - mime-types-data (3.2016.0521) - mini_portile2 (2.0.0) + mini_portile2 (2.4.0) minitest (5.11.3) multi_json (1.13.1) multipart-post (2.0.0) - nokogiri (1.6.7.2) - mini_portile2 (~> 2.0.0.rc2) - padrino-helpers (0.12.9) + nokogiri (1.10.1) + mini_portile2 (~> 2.4.0) + padrino-helpers (0.13.3.4) i18n (~> 0.6, >= 0.6.7) - padrino-support (= 0.12.9) + padrino-support (= 0.13.3.4) tilt (>= 1.4.1, < 3) - padrino-support (0.12.9) + padrino-support (0.13.3.4) activesupport (>= 3.1) + parallel (1.17.0) phantomjs (2.1.1.0) - public_suffix (3.0.2) - puma (3.11.4) + public_suffix (3.0.3) + puma (3.12.1) rack (1.6.10) rack-livereload (0.3.17) rack rack-rewrite (1.5.1) - rack-test (1.0.0) - rack (>= 1.0, < 3) rake (12.3.1) rb-fsevent (0.10.3) - rb-inotify (0.9.10) - ffi (>= 0.5.0, < 2) + rb-inotify (0.10.0) + ffi (~> 1.0) redcarpet (3.2.3) ref (2.0.0) rouge (1.11.1) sass (3.4.25) - sprockets (2.12.4) - hike (~> 1.2) - multi_json (~> 1.0) - rack (~> 1.0) - tilt (~> 1.1, != 1.3.0) - sprockets-helpers (1.1.0) - sprockets (~> 2.0) - sprockets-sass (1.3.1) - sprockets (~> 2.0) - tilt (~> 1.1) - temple (0.8.0) + servolux (0.13.0) + sprockets (3.7.2) + concurrent-ruby (~> 1.0) + rack (> 1, < 3) + temple (0.8.1) therubyracer (0.12.3) libv8 (~> 3.16.14.15) ref - thor (0.20.0) + thor (0.19.1) thread_safe (0.3.6) tilt (1.4.1) tzinfo (1.2.5) thread_safe (~> 0.1) - uber (0.0.15) - uglifier (2.7.2) - execjs (>= 0.3.0) - json (>= 1.8.0) - xpath (2.1.0) - nokogiri (~> 1.3) + uglifier (3.2.0) + execjs (>= 0.3.0, < 3) PLATFORMS ruby DEPENDENCIES - bookbindery (= 9.12.0) + bookbindery (= 10.1.15) font-awesome-sass (= 4.7.0) jasmine rake therubyracer BUNDLED WITH - 1.16.1 + 1.17.3 diff --git a/README.md b/README.md index 0c0a0f00..e74a190d 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ This repository does not contain the documentation content. Documentation conten The following list describes the topic repositories that make up the Cloud Foundry documentation set * [Cloud Foundry Concepts](http://github.com/cloudfoundry/docs-cloudfoundry-concepts): Underlying concepts and architecture -* [Cloud Foundry Command-Line Interface (cf CLI)](https://github.com/cloudfoundry/docs-cf-cli): A guide to the cf CLI for Cloud Foundry developers and users +* [Cloud Foundry Command-Line Interface (cf CLI)](https://github.com/cloudfoundry/docs-cf-cli): A guide to the cf CLI for Cloud Foundry developers and users * [Developer Guide](http://github.com/cloudfoundry/docs-dev-guide): Step-by-step instructions and reference material for developers pushing applications to Cloud Foundry * [Deploying Cloud Foundry](http://github.com/cloudfoundry/docs-deploying-cf): Instructions for operators using BOSH to deploying Cloud Foundry on AWS, vSphere, vCloud, OpenStack, etc. * [Running Cloud Foundry](http://github.com/cloudfoundry/docs-running-cf): Information for operators running Cloud Foundry @@ -41,7 +41,7 @@ To submit a pull request to the documentation, follow this process: 1. Make sure you have a signed CLA. Even if you aren't contributing running code, we still need a Contributor License Agreement. 1. Fork the content repository you want to make a contribution to. See the following examples: - * For the Buildpacks Docs at http://docs.cloudfoundry.org/buildpacks/index.html, the content repo is: https://github.com/cloudfoundry/docs-buildpacks. + * For the Buildpacks Docs at http://docs.cloudfoundry.org/buildpacks/index.html, the content repo is: https://github.com/cloudfoundry/docs-buildpacks. * For the Developer Guide Docs at http://docs.cloudfoundry.org/devguide/services/, the content repo is: https://github.com/cloudfoundry/docs-dev-guide 1. Clone your fork of the content repository. Make sure to clone your fork of the topic repository to a directory that is a sibling to this book repository. So, for example, if you are contributing content to the Buildpack documentation, your folder structure would look like this: @@ -55,8 +55,8 @@ To submit a pull request to the documentation, follow this process: | -1. Make your changes. - +1. Make your changes. + 1. Run bookbinder on your local changes:
@@ -66,15 +66,15 @@ To submit a pull request to the documentation, follow this process:
   
Bookbinder attempts to assemble the doc set from your local copies. - It skips any topic repositories that you do not have checked out. For more information on Bookbinder, see the Bookbinder README. + It skips any topic repositories that you do not have checked out. For more information on Bookbinder, see the Bookbinder README. -1. Point your browser at localhost:4567 to preview your changes. On save, your browser will reload with any additional changes you make. +1. Point your browser at localhost:4567 to preview your changes. On save, your browser will reload with any additional changes you make. 1. Commit your changes, rebase from upstream, and push to your fork. 1. Submit a pull request (PR) from your fork to the original repositories. -The CF Docs team will review and merge the PR. They may contact you with questions or edit the PR for formatting and style. +The CF Docs team will review and merge the PR. They may contact you with questions or edit the PR for formatting and style. **Note**: After your pull request is merged, your changes appear on [docs.cloudfoundry.org](http://docs.cloudfoundry.org) the next time the cf-docs team pushes updates to the production docs. Updates go live at least once a week. ## Determine Content Repos and Branches of a Book @@ -95,7 +95,7 @@ or on the branch corresponding to its version number. 3. Search for the name of the content repo, for example, `docs-cloudfoundry-concepts`. -4. Review the `repository` subsection for the content repo. If there is no `ref:` tag, then the repo uses the master branch. If there is a `ref` key-value pair, it specifies the branch name of the content repo. For example, +4. Review the `repository` subsection for the content repo. If there is no `ref:` tag, then the repo uses the `main` branch. If there is a `ref` key-value pair, it specifies the branch name of the content repo. For example, ``` - repository: @@ -103,6 +103,5 @@ or on the branch corresponding to its version number. ref: '225' ``` - `ref: '225'` refers to the 225 branch of the docs-cloudfoundry-concepts repo. Cloud Foundry `225` is associated with v255 of cf-release. + `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. - diff --git a/config.yml b/config.yml index ae36730b..18ab490f 100644 --- a/config.yml +++ b/config.yml @@ -8,93 +8,9 @@ elastic_search: true public_host: docs.cloudfoundry.org sections: -- repository: - name: cloudfoundry/docs-buildpacks - ref: master - directory: buildpacks - subnav_template: cf-subnav.erb - dependent_sections: - - repository: - name: cloudfoundry-samples/pong_matcher_grails - no_docs: true - - repository: - name: cloudfoundry-samples/pong_matcher_groovy - no_docs: true - - repository: - name: cloudfoundry-samples/pong_matcher_spring - no_docs: true - - repository: - name: cloudfoundry-samples/pong_matcher_ruby - no_docs: true -- repository: - name: cloudfoundry/docs-bbr - ref: master - directory: bbr - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-cf-admin - ref: master - directory: adminguide - subnav_template: cf-subnav.erb - repository: name: cloudfoundry/docs-cf-cli - ref: master + ref: "v7" directory: cf-cli subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-cloudfoundry-concepts - ref: master - directory: concepts - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-credhub - ref: master - directory: credhub - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-deploying-cf - ref: master - directory: deploying - subnav_template: cf-subnav.erb - dependent_sections: - - repository: - name: cloudfoundry/cf-release - no_docs: true -- repository: - name: cloudfoundry/docs-dev-guide - ref: master - directory: devguide - subnav_template: cf-subnav.erb - dependent_sections: - - repository: - name: cloudfoundry/cf-networking-release - at_path: docs - no_docs: true - - repository: - name: cloudfoundry-samples/pong_matcher_spring - no_docs: true -- repository: - name: cloudfoundry/docs-loggregator - ref: master - directory: loggregator - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-routing - ref: master - directory: routing - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-running-cf - ref: master - directory: running - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-services - ref: master - directory: services - subnav_template: cf-subnav.erb -- repository: - name: cloudfoundry/docs-uaa - ref: master - directory: uaa - subnav_template: cf-subnav.erb + diff --git a/config/template_variables.yml b/config/template_variables.yml index 37d19c88..8aaef9e0 100644 --- a/config/template_variables.yml +++ b/config/template_variables.yml @@ -110,7 +110,7 @@ template_variables: grant_devs_c2c: edit your BOSH manifest to include the enable_space_developer_self_service property in the cf-networking-release policy-server job and set that property to true GSG_intro_sentence: health_monitor_footnote: Configuring Health Monitor Notifications - http_routing: For more information, see the [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html) topic. + http_routing: For more information, see the [Securing Traffic into Cloud Foundry](https://docs.cloudfoundry.org/adminguide/securing-traffic.html) topic. healthcheck_duration: The duration of the healthcheck Service Unavailable response is configurable using the manifest property router.requested_route_registration_interval_in_seconds, which defaults to 20 seconds. info_loc: In your Cloud Foundry deployment manifest ipsec_note: @@ -165,7 +165,7 @@ template_variables: scale_table: "oss_scale_table" scaling_ert_db: scaling_ert: - self_signed: Before following the procedure below, the developer must obtain either the self-signed certificate or the intermediate and CA certificates used to sign the deployment'’s certificate. The developer can obtain these certificates from the CF operator or from the deployment manifest. Review the [Securing Traffic into Cloud Foundry](../adminguide/securing-traffic.html) topic for more information about how to retrieve certificates from the deployment manifest. + self_signed: Before following the procedure below, the developer must obtain either the self-signed certificate or the intermediate and CA certificates used to sign the deployment'’s certificate. The developer can obtain these certificates from the CF operator or from the deployment manifest. Review the [Securing Traffic into Cloud Foundry](https://docs.cloudfoundry.org/adminguide/securing-traffic.html) topic for more information about how to retrieve certificates from the deployment manifest. services_link: services services: services ssh_marketplace_output: mysql 100mb MySQL databases on demand @@ -187,7 +187,7 @@ template_variables: uaa_cred: refer to the uaa scim section uaa: UAA understanding_asg_individual_link: Application Security Groups - upload_custom_buildpacks: You can also use the cf create-buildpack command to upload the buildpack into your Cloud Foundry deployment, making it accessible without the -b flag:
$ cf create-buildpack BUILDPACK PATH POSITION [--enable|--disable]
+ upload_custom_buildpacks: You can also use the cf create-buildpack command to upload the buildpack into your Cloud Foundry deployment, making it accessible without the -b flag:
$ cf create-buildpack BUILDPACK PATH POSITION
user_org_creation: v3_cli_versions: The experimental commands described in this topic require the cf CLI v6.32.0+ and a Cloud Foundry deployment with CC API 3.27.0+. The minimum version of the required CC API will change in subsequent releases. warden_garden: diff --git a/master_middleman/source/index.html.md.erb b/master_middleman/source/index.html.md.erb index 1228de83..0c4507b0 100644 --- a/master_middleman/source/index.html.md.erb +++ b/master_middleman/source/index.html.md.erb @@ -33,587 +33,4 @@ breadcrumb: Cloud Foundry Documentation - - -
-
-

Contributing Documentation -

-
Contribute to the Cloud Foundry documentation. -
-
-
- -
-

Deploy Cloud Foundry -

-
Deploy Cloud Foundry on different infrastructures. -
-
- -
-
- -
-

Cloud Foundry CLI

-
Direct a CF deployment from your local command line.
-
- -
-
- -
-

Develop and Manage Applications

-
Develop, run, and track applications in the cloud.
-
- -
Integrating Service Instances with Applications
- -
-
- -
-

Custom Services

-
Create and publish free or metered services for Cloud Foundry apps.
-
- -
-
- -
-

Administer Cloud Foundry and Users

-
A guide for administrators.
-
- -
-
- -
-

Buildpacks

-
Package the languages and libraries that support your apps.
-
- -
Java
- -
Node.js
- -
Ruby
- -
Other Buildpacks
- -
-
- -
-

Run and Troubleshoot Cloud Foundry

-
A guide for operators.
-
- -
-
- -
-

Cloud Foundry Concepts

-
Understand how Cloud Foundry works.
-
- -
-
- -
-

Logging and Metrics in Cloud Foundry

-
Aggregate and stream logs and metrics from Cloud Foundry. -
-
- -
-
- -
-

API Reference

-
-
- -
- -
- + \ No newline at end of file diff --git a/master_middleman/source/subnavs/_cf-subnav.erb b/master_middleman/source/subnavs/_cf-subnav.erb index 04adba51..0bbc4b0d 100644 --- a/master_middleman/source/subnavs/_cf-subnav.erb +++ b/master_middleman/source/subnavs/_cf-subnav.erb @@ -4,779 +4,12 @@