Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: cloudfoundry/docs-book-cloudfoundry
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: master
Choose a base ref
...
head repository: swisscom/docs-appcloud-book
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: master
Choose a head ref
Can’t automatically merge. Don’t worry, you can still create the pull request.
Loading
Showing with 67,745 additions and 306 deletions.
  1. +0 −1 CODEOWNERS
  2. +1 −0 CODE_OF_CONDUCT.md
  3. +29 −0 CONTRIBUTING.md
  4. +219 −0 Gemfile.lock
  5. +37 −88 README.md
  6. +7 −0 _book/.gitignore
  7. +1 −0 _book/.ruby-version
  8. +3 −0 _book/Gemfile
  9. +205 −0 _book/Gemfile.lock
  10. +201 −0 _book/LICENSE
  11. +15 −0 _book/NOTICE
  12. +12 −0 _book/ci/scripts/build.ci.sh
  13. +7 −0 _book/ci/scripts/build.sh
  14. +163 −0 _book/config.yml
  15. +213 −0 _book/config/template_variables.yml
  16. BIN _book/gitbook/fonts/fontawesome/FontAwesome.otf
  17. BIN _book/gitbook/fonts/fontawesome/fontawesome-webfont.eot
  18. +685 −0 _book/gitbook/fonts/fontawesome/fontawesome-webfont.svg
  19. BIN _book/gitbook/fonts/fontawesome/fontawesome-webfont.ttf
  20. BIN _book/gitbook/fonts/fontawesome/fontawesome-webfont.woff
  21. BIN _book/gitbook/fonts/fontawesome/fontawesome-webfont.woff2
  22. +240 −0 _book/gitbook/gitbook-plugin-fontsettings/fontsettings.js
  23. +291 −0 _book/gitbook/gitbook-plugin-fontsettings/website.css
  24. +135 −0 _book/gitbook/gitbook-plugin-highlight/ebook.css
  25. +434 −0 _book/gitbook/gitbook-plugin-highlight/website.css
  26. +11 −0 _book/gitbook/gitbook-plugin-livereload/plugin.js
  27. +7 −0 _book/gitbook/gitbook-plugin-lunr/lunr.min.js
  28. +59 −0 _book/gitbook/gitbook-plugin-lunr/search-lunr.js
  29. +7 −0 _book/gitbook/gitbook-plugin-search/lunr.min.js
  30. +50 −0 _book/gitbook/gitbook-plugin-search/search-engine.js
  31. +35 −0 _book/gitbook/gitbook-plugin-search/search.css
  32. +213 −0 _book/gitbook/gitbook-plugin-search/search.js
  33. +90 −0 _book/gitbook/gitbook-plugin-sharing/buttons.js
  34. +4 −0 _book/gitbook/gitbook.js
  35. BIN _book/gitbook/images/apple-touch-icon-precomposed-152.png
  36. BIN _book/gitbook/images/favicon.ico
  37. +9 −0 _book/gitbook/style.css
  38. +4 −0 _book/gitbook/theme.js
  39. +267 −0 _book/index.html
  40. +9 −0 _book/manifest.dev.yml
  41. +13 −0 _book/manifest.yml
  42. +18 −0 _book/master_middleman/source/404.html.erb
  43. +95 −0 _book/master_middleman/source/contribute.html.md.erb
  44. +1 −0 _book/master_middleman/source/googlefb873635f2f14682.html
  45. BIN _book/master_middleman/source/images/Pipe_NavBar.png
  46. BIN _book/master_middleman/source/images/Pipe_gBar.png
  47. BIN _book/master_middleman/source/images/bg_social_footer.png
  48. BIN _book/master_middleman/source/images/cf-icons.png
  49. BIN _book/master_middleman/source/images/facebook_large.png
  50. BIN _book/master_middleman/source/images/favicon.ico
  51. BIN _book/master_middleman/source/images/gplus_large.png
  52. BIN _book/master_middleman/source/images/hr-horizontal-dark.png
  53. BIN _book/master_middleman/source/images/hr-vertical.png
  54. BIN _book/master_middleman/source/images/ico-cancel-x.png
  55. BIN _book/master_middleman/source/images/ico-search.png
  56. +16 −0 _book/master_middleman/source/images/logo_appcloud.svg
  57. BIN _book/master_middleman/source/images/ribbon_forkme.png
  58. +1 −0 _book/master_middleman/source/images/search.svg
  59. BIN _book/master_middleman/source/images/searchsprite.png
  60. BIN _book/master_middleman/source/images/twitter_large.png
  61. BIN _book/master_middleman/source/images/youtube_large.png
  62. +92 −0 _book/master_middleman/source/index.html.md.erb
  63. +18 −0 _book/master_middleman/source/javascripts/book.js
  64. +1 −0 _book/master_middleman/source/javascripts/page_initializers/documentation.js.erb
  65. +59,088 −0 _book/master_middleman/source/javascripts/vendor/mermaid.js
  66. +300 −0 _book/master_middleman/source/javascripts/waypoints/context.js
  67. +105 −0 _book/master_middleman/source/javascripts/waypoints/group.js
  68. +213 −0 _book/master_middleman/source/javascripts/waypoints/noframeworkAdapter.js
  69. +63 −0 _book/master_middleman/source/javascripts/waypoints/sticky.js
  70. +160 −0 _book/master_middleman/source/javascripts/waypoints/waypoint.js
  71. +18 −0 _book/master_middleman/source/layouts/_additional-scripts.erb
  72. +7 −0 _book/master_middleman/source/layouts/_book-footer.erb
  73. +14 −0 _book/master_middleman/source/layouts/_book-search.erb
  74. +1 −0 _book/master_middleman/source/owners.json.erb
  75. +5 −0 _book/master_middleman/source/search.html.erb
  76. +457 −0 _book/master_middleman/source/stylesheets/book-styles.scss
  77. +7 −0 _book/master_middleman/source/stylesheets/partials/_book-base-values.scss
  78. +13 −0 _book/master_middleman/source/stylesheets/partials/_book-vars.scss
  79. +275 −0 _book/master_middleman/source/stylesheets/vendor/mermaid.scss
  80. +712 −0 _book/master_middleman/source/subnavs/_cf-subnav.erb
  81. +502 −0 _book/master_middleman/source/subnavs/_sc-subnav.erb
  82. +58 −0 _book/master_middleman/source/subnavs/_tutorial-clojure-subnav.erb
  83. +58 −0 _book/master_middleman/source/subnavs/_tutorial-dotnetcore-subnav.erb
  84. +58 −0 _book/master_middleman/source/subnavs/_tutorial-go-subnav.erb
  85. +58 −0 _book/master_middleman/source/subnavs/_tutorial-java-subnav.erb
  86. +58 −0 _book/master_middleman/source/subnavs/_tutorial-nodejs-subnav.erb
  87. +58 −0 _book/master_middleman/source/subnavs/_tutorial-php-subnav.erb
  88. +58 −0 _book/master_middleman/source/subnavs/_tutorial-python-subnav.erb
  89. +58 −0 _book/master_middleman/source/subnavs/_tutorial-ruby-subnav.erb
  90. +107 −0 _book/redirects.rb
  91. +6 −0 _book/run.sh
  92. +1 −0 _book/search_index.json
  93. +12 −0 ci/scripts/build.ci.sh
  94. +7 −0 ci/scripts/build.sh
  95. +83 −12 config.yml
  96. +53 −46 config/template_variables.yml
  97. +9 −0 manifest.dev.yml
  98. +10 −7 manifest.yml
  99. BIN master_middleman/source/images/bg-crowd.png
  100. BIN master_middleman/source/images/bg-plain-x.jpg
  101. BIN master_middleman/source/images/favicon.ico
  102. BIN master_middleman/source/images/logo-footer-pivotal.png
  103. BIN master_middleman/source/images/logo-pws.png
  104. +16 −0 master_middleman/source/images/logo_appcloud.svg
  105. BIN master_middleman/source/images/logo_org.png
  106. BIN master_middleman/source/images/new_logo_org.png
  107. BIN master_middleman/source/images/pws-logo-dark-bg.png
  108. BIN master_middleman/source/images/pws-logo-light-bg.png
  109. +1 −0 master_middleman/source/images/search.svg
  110. +43 −142 master_middleman/source/index.html.md.erb
  111. +3 −3 master_middleman/source/layouts/_book-footer.erb
  112. +12 −0 master_middleman/source/layouts/_book-search.erb
  113. +0 −2 master_middleman/source/robots.txt
  114. +96 −0 master_middleman/source/stylesheets/book-styles.scss
  115. +3 −3 master_middleman/source/stylesheets/partials/_book-vars.scss
  116. +0 −2 master_middleman/source/subnavs/_cf-subnav.erb
  117. +497 −0 master_middleman/source/subnavs/_sc-subnav.erb
  118. +58 −0 master_middleman/source/subnavs/_tutorial-clojure-subnav.erb
  119. +58 −0 master_middleman/source/subnavs/_tutorial-dotnetcore-subnav.erb
  120. +58 −0 master_middleman/source/subnavs/_tutorial-go-subnav.erb
  121. +58 −0 master_middleman/source/subnavs/_tutorial-java-subnav.erb
  122. +58 −0 master_middleman/source/subnavs/_tutorial-nodejs-subnav.erb
  123. +58 −0 master_middleman/source/subnavs/_tutorial-php-subnav.erb
  124. +58 −0 master_middleman/source/subnavs/_tutorial-python-subnav.erb
  125. +58 −0 master_middleman/source/subnavs/_tutorial-ruby-subnav.erb
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

1 change: 1 addition & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
For interactions on GitHub, Swisscom’s [Social Media Netiquette](https://www.swisscom.ch/en/residential/legal-information/social-media-netiquette.html) applies.
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Contributing

We welcome contributions and are really glad about your involvement in the project.

## Reporting Feedback

Use GitHub’s issues feature to report problems with and request enhancements to the functionality or documentation.

## Contributing Code

Code contributions are highly appreciated. Bug fixes and small enhancements can be handed in as pull-requests. For larger changes and features, please open a GitHub issue with your proposal first so the solution can be discussed.

### Commit Guidelines

All your commits must follow the [conventional commit message format](https://www.conventionalcommits.org/en/v1.0.0/#summary).

Valid scopes for this project are:

- `editor`: changes to the script editor GUI
- `runner`: changes to the script execution logic
- `meta`: changes to the build process, deployment, packaging or the project setup

Commits that fall into none of these scopes or change aspects in more than one of them should not specify a scope.

Ideally, each commit should should represent a working and buildable state but still only contain an atomic change compared to its parent. Please rewrite history accordingly before opening a PR.

### License

By contributing code or documentation, you agree to have your contribution licensed under [our license](/LICENSE).
219 changes: 219 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
GEM
remote: http://rubygems.org/
specs:
activesupport (4.2.10)
i18n (~> 0.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
ansi (1.5.0)
bookbindery (9.12.1)
ansi (~> 1.4)
css_parser
elasticsearch
fog-aws (~> 0.7.1)
font-awesome-sass
git (~> 1.2.8)
middleman (~> 3.4.0)
middleman-livereload (~> 3.4.3)
middleman-syntax (~> 2.0)
nokogiri (= 1.6.7.2)
puma
rack-rewrite
redcarpet (~> 3.2.3)
rouge (!= 1.9.1)
therubyracer
thor
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.11)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
compass (1.0.3)
chunky_png (~> 1.2)
compass-core (~> 1.0.2)
compass-import-once (~> 1.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
sass (>= 3.3.13, < 3.5)
compass-core (1.0.3)
multi_json (~> 1.0)
sass (>= 3.3.0, < 3.5)
compass-import-once (1.0.5)
sass (>= 3.2, < 3.5)
css_parser (1.7.0)
addressable
elasticsearch (7.3.0)
elasticsearch-api (= 7.3.0)
elasticsearch-transport (= 7.3.0)
elasticsearch-api (7.3.0)
multi_json
elasticsearch-transport (6.0.2)
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.7)
excon (0.76.0)
execjs (2.7.0)
faraday (0.17.0)
multipart-post (>= 1.2, < 3)
ffi (1.11.1)
fog-aws (0.7.6)
fog-core (~> 1.27)
fog-json (~> 1.0)
fog-xml (~> 0.1)
ipaddress (~> 0.8)
fog-core (1.45.0)
builder
excon (~> 0.58)
formatador (~> 0.2)
fog-json (1.0.2)
fog-core (~> 1.0)
multi_json (~> 1.10)
fog-xml (0.1.3)
fog-core
nokogiri (>= 1.5.11, < 2.0.0)
font-awesome-sass (4.7.0)
sass (>= 3.2)
formatador (0.2.5)
git (1.2.9.1)
haml (5.0.4)
temple (>= 0.8.0)
tilt
hike (1.2.3)
hooks (0.4.1)
uber (~> 0.0.14)
http_parser.rb (0.6.0)
i18n (0.7.0)
ipaddress (0.8.3)
jasmine (3.1.0)
jasmine-core (= 3.1.0)
phantomjs
rack (>= 1.2.1)
rake
jasmine-core (3.1.0)
json (2.3.1)
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)
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)
sass (>= 3.4.0, < 4.0)
uglifier (~> 2.5)
middleman-core (3.4.1)
activesupport (~> 4.1)
bundler (~> 1.1)
capybara (~> 2.4.4)
erubis
hooks (~> 0.3)
i18n (~> 0.7.0)
listen (~> 3.0.3)
padrino-helpers (~> 0.12.3)
rack (>= 1.4.5, < 2.0)
thor (>= 0.15.2, < 2.0)
tilt (~> 1.4.1, < 2.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-syntax (2.1.0)
middleman-core (>= 3.2)
rouge (~> 1.0)
mime-types (3.3)
mime-types-data (~> 3.2015)
mime-types-data (3.2019.1009)
mini_portile2 (2.0.0)
minitest (5.12.2)
multi_json (1.14.1)
multipart-post (2.1.1)
nio4r (2.5.2)
nokogiri (1.6.7.2)
mini_portile2 (~> 2.0.0.rc2)
padrino-helpers (0.12.9)
i18n (~> 0.6, >= 0.6.7)
padrino-support (= 0.12.9)
tilt (>= 1.4.1, < 3)
padrino-support (0.12.9)
activesupport (>= 3.1)
phantomjs (2.1.1.0)
public_suffix (4.0.1)
puma (4.3.5)
nio4r (~> 2.0)
rack (1.6.10)
rack-livereload (0.3.17)
rack
rack-rewrite (1.5.1)
rack-test (1.1.0)
rack (>= 1.0, < 3)
rake (12.3.3)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
redcarpet (3.2.3)
ref (2.0.0)
rouge (1.11.1)
sass (3.4.25)
sprockets (2.12.5)
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.2)
therubyracer (0.12.3)
libv8 (~> 3.16.14.15)
ref
thor (0.20.3)
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)

PLATFORMS
ruby

DEPENDENCIES
bookbindery (= 9.12.1)
font-awesome-sass (= 4.7.0)
jasmine
rake
therubyracer

BUNDLED WITH
1.16.1
125 changes: 37 additions & 88 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,107 +1,56 @@
# Cloud Foundry Documentation
# Application Cloud Documentation

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

This repository uses the [Bookbindery gem](http://github.com/pivotal-cf/docs-bookbinder) to generate the documentation as a web application. The Bookbinder gem has been tested with the following Ruby versions:
These docs can be reached at <https://docs.developer.swisscom.com>

* 2.5.3
* 2.5.5
* 2.6.3
* 2.6.6
* 2.6.8
## What's in this Repository

The config.yml file contains the list of topic repositories.
This repo uses the [Bookbindery gem](http://rubygemsearch.org/rubygems/bookbindery) to generate the documentation as a web application.

The master_middleman folder contains the layouts, styles, and subnav used to create the web pages.
The `config.yml` file contains the list of topic repositories.

This repository does not contain the documentation content. Documentation content is contained in the topic repositories listed in the config.yml.
The `master_middleman` folder contains the template used for publishing

## Topic Repositories

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
* [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
* [Administrator Tools](https://github.com/cloudfoundry/docs-cf-admin): Documentation about operating Cloud Foundry deployments using BOSH and the cf command line tool
* [Services](http://github.com/cloudfoundry/docs-services): Information about extending Cloud Foundry with custom services, and the service broker API
* [Buildpacks](http://github.com/cloudfoundry/docs-buildpacks): Guides to developing your own buildpacks
* [Loggregator](http://github.com/cloudfoundry/docs-loggregator): Information about the user application logging subsystem of Cloud Foundry
* [User Account and Authentication](https://github.com/cloudfoundry/uaa): Information about the Cloud Foundry User Account and Authentication (UAA) Server

## Contributing Pull Requests

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 repository is: https://github.com/cloudfoundry/docs-buildpacks.
* For the Developer Guide Docs at http://docs.cloudfoundry.org/devguide/services/, the content repository 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:

<pre>
|
+-- docs-book-cloudfoundry
|
+-- docs-buildpacks
|
</pre>

1. Make your changes.
This repository does not contain the documentation content. That's contained in the topic repositories listed in the `config.yml`.

1. Run bookbinder on your local changes.

<pre>
$ cd docs-book-cloudfoundry
$ bundle install
$ bundle exec bookbinder watch
</pre>

> **Tip:** If you run into issues with `libv8` on macOS, try following [these steps](https://gist.github.com/fernandoaleman/868b64cd60ab2d51ab24e7bf384da1ca#gistcomment-3081153) using a **non-system** version of Ruby ([`rbenv`](https://github.com/rbenv/rbenv) recommended).
> **Tip:** If you run into issues with the installation of Ruby 2.6.8 on macOS Ventura, try following [steps](docker/README.md) and run it inside a container.
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 about Bookbinder, see the <a href="https://github.com/pivotal-cf/bookbinder#bookbinder">Bookbinder README</a>.


1. Point your browser at <code>localhost:4567</code> 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.
**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.
## Topic Repositories

## Determine Content Repositories and Branches of a Book
The topic repositories that make up the App Cloud documentation set are:

The `config.yml` defines the content repositories for each book.
The `config.yml` file of each book contains the list of content repositories and branches that appear in the doc set.
In the `config.yml` file, each content repository is specified in the `repository` subsection.
This subsection includes an optional `ref` key-value pair which defines the branch of the content repository that the book uses.
* [Cloud Foundry Concepts](https://github.com/cloudfoundry/docs-cloudfoundry-concepts): a guide to the underlying concepts and architecture.
* [Developer Guide](https://github.com/cloudfoundry/docs-dev-guide): step-by-step instructions and reference material for developers pushing applications to Cloud Foundry.
* [CF CLI](https://github.com/cloudfoundry/docs-cf-cli): a guide to using the Cloud Foundry CLI.
* [Administrator Tools](https://github.com/cloudfoundry/docs-cf-admin): documentation about how to operate Cloud Foundry deployments using bosh and cf command line tools.
* [Services](https://github.com/cloudfoundry/docs-services): information about extending Cloud Foundry with custom services, and the service broker API.
* [Running Cloud Foundry](https://github.com/cloudfoundry/docs-running-cf): information for operators running Cloud Foundry.
* [Buildpacks](https://github.com/cloudfoundry/docs-buildpacks): a guide to developing your own buildpacks.
* [Getting Started](https://github.com/swisscom/docs-appcloud-getting-started): a guide for new users on how to get started with the App Cloud
* [Web Console](https://github.com/swisscom/docs-appcloud-console): a guide about using the web console on [https://developer.swisscom.com](https://developer.swisscom.com)
* [Apps](https://github.com/swisscom/docs-appcloud-apps): a guide about apps
* [Service Offerings](https://github.com/swisscom/docs-appcloud-service-offerings): a list of the different service offerings of Swisscom
* [Billing](https://github.com/swisscom/docs-appcloud-billing): shows how billing in the app cloud works and makes it more transparent for users
* [API](https://github.com/swisscom/docs-api): a guide on how to use the Swisscom APIs

Make sure that you are adding your content to the correct branches of the content repositories.
## Build

To determine which branch of a content repository that a book version uses:
### Setup

1. Confirm that you are on the correct book branch. For example, the currently published doc might be on the `main` branch
or on the branch corresponding to its version number.
1. Run `bundle install`

2. Open the `config.yml` file.
### Bind

3. Search for the name of the content repository, for example, `docs-cloudfoundry-concepts`.
1. Run `bundle exec bookbinder bind remote`

4. Review the `repository` subsection for the content repository. If there is no `ref:` tag, then the repository uses the main branch. If there is a `ref` key-value pair, it specifies the branch name of the content repository. For example:
### Run locally

```
- repository:
name: cloudfoundry/docs-cloudfoundry-concepts
ref: '225'
```
1. Build the docs
1. Run `cd final_app`
1. Run `rackup`
1. Open your web browser at the specified URL

`ref: '225'` refers to the 225 branch of the docs-cloudfoundry-concepts repository. 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.

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