From 1c3bcb43b8e0ea34f96f2423f3e6d55aaf1da2b5 Mon Sep 17 00:00:00 2001 From: Johannes Dillmann Date: Wed, 18 Sep 2024 15:05:35 +0200 Subject: [PATCH 1/3] Add first rough structure for cnb Co-authored-by: Ralf Pannemans --- master_middleman/source/index.html.md.erb | 93 ++++++++----- .../source/subnavs/_cf-subnav.erb | 125 ++++++++++-------- 2 files changed, 128 insertions(+), 90 deletions(-) diff --git a/master_middleman/source/index.html.md.erb b/master_middleman/source/index.html.md.erb index db927cd1..a8d88d7a 100644 --- a/master_middleman/source/index.html.md.erb +++ b/master_middleman/source/index.html.md.erb @@ -360,129 +360,150 @@ breadcrumb: Cloud Foundry Documentation

Buildpacks

Package the languages and libraries that support your apps.

+

Classical Buildpacks

+
Package the languages and libraries that support your apps.
+
Java
Node.js
Ruby
Other buildpacks
+ +

Cloud Native Buildpacks

+
Package the languages and libraries that support your apps.
+
+
diff --git a/master_middleman/source/subnavs/_cf-subnav.erb b/master_middleman/source/subnavs/_cf-subnav.erb index 6ab70db1..0fc313bf 100644 --- a/master_middleman/source/subnavs/_cf-subnav.erb +++ b/master_middleman/source/subnavs/_cf-subnav.erb @@ -266,90 +266,107 @@
  • Cloud Foundry API app revisions
  • -
  • Buildpacks + + +
  • Buildpacks +

  • Information for Managed Service Authors
      From e95de83c3f8cda6850cf98a1594392e47084e70a Mon Sep 17 00:00:00 2001 From: Ralf Pannemans Date: Wed, 18 Sep 2024 16:05:52 +0200 Subject: [PATCH 2/3] Add redirects Co-authored-by: Johannes Dillmann Co-authored-by: Ralf Pannemans --- config/template_variables.yml | 6 +-- master_middleman/source/index.html.md.erb | 4 +- redirects.rb | 49 ++++++++++++++++++++--- 3 files changed, 48 insertions(+), 11 deletions(-) diff --git a/config/template_variables.yml b/config/template_variables.yml index cb945783..a7ac6a6e 100644 --- a/config/template_variables.yml +++ b/config/template_variables.yml @@ -151,9 +151,9 @@ template_variables: diego_architecture: This topic provides an overview of the structure and components of Diego, the container management system for Cloud Foundry. diego_deploy: To deploy Diego, see the [Cloud Foundry Diego (BOSH release)](https://github.com/cloudfoundry-incubator/diego-release) repository on GitHub. diego_ssh_link: Diego SSH package - disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. + disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. disable_custom_buildpacks: You can disable custom buildpacks for an entire deployment by adding disable_custom_buildpacks: true in your Cloud Foundry manifest under `properties.cc`. - disable_custom:

      Disabling Custom Buildpacks

      Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. + disable_custom:

      Disabling Custom Buildpacks

      Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. docker_auth: To run Docker containers, Cloud Foundry needs the ability to access Docker registries using a Certificate Authority. To configure this access, see [Installing Certificates on VMs](ttps://bosh.io/docs/trusted-certs.html) in the BOSH documentation. domain_name: cloudfoundry.org domains_shared_domains: @@ -193,7 +193,7 @@ template_variables: link_adminguide_buildpack: For more information, see [Managing Custom Buildpacks](../adminguide/buildpacks.html). link_adminguide_commands:

      Note An Org Manager needs explicit admin permissions to perform certain actions. To create a user with admin rights, see Creating and Managing Users with the UAA CLI (UAAC).

      link_adminguide_domains: For admin-specific commands, see [Managing Domains and Routes](../../adminguide/manage-domains-routes.html). - link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, see [Configuring Trusted System Certificates for Applications](../../running/trusted-system-certificates.html). + link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, see [Configuring Trusted System Certificates for Applications](../../../running/trusted-system-certificates.html). log_management: logg_forwarding: the [Enabling System Log Forwarding](../running/managing-cf/logging-config.html#syslog-forward) section of the _Configuring System Logging_ topic. logg_scaling: Scaling Loggregator section of the Configuring System Logging topic. diff --git a/master_middleman/source/index.html.md.erb b/master_middleman/source/index.html.md.erb index a8d88d7a..92d21168 100644 --- a/master_middleman/source/index.html.md.erb +++ b/master_middleman/source/index.html.md.erb @@ -360,7 +360,7 @@ breadcrumb: Cloud Foundry Documentation

      Buildpacks

      Package the languages and libraries that support your apps.

      -

      Classical Buildpacks

      +

      Classical Buildpacks

      Package the languages and libraries that support your apps.

      @@ -487,7 +487,7 @@ breadcrumb: Cloud Foundry Documentation
  • -

    Cloud Native Buildpacks

    +

    Cloud Native Buildpacks

    Package the languages and libraries that support your apps.

    diff --git a/redirects.rb b/redirects.rb index 17f501f0..a6fc6afd 100644 --- a/redirects.rb +++ b/redirects.rb @@ -36,7 +36,7 @@ r301 '/deploying/common/log_drain_blacklists.html', '/loggregator/data-sources.html' r301 '/devguide/deploy-apps/domains-routes.html', '/devguide/deploy-apps/routes-domains.html' -r301 '/devguide/deploy-apps/sts.html', '/buildpacks/java/index.html' +r301 '/devguide/deploy-apps/sts.html', '/buildpacks/classical/java/index.html' r301 '/devguide/deploy-apps/api-endpoint.html', '/running/cf-api-endpoint.html' r301 '/devguide/installcf/whats-new-v6.html', '/cf-cli/getting-started.html' r301 '/devguide/installcf/http-proxy.html', '/cf-cli/http-proxy.html' @@ -61,9 +61,9 @@ r301 '/concepts/ha-levels.html', '/concepts/high-availability.html#cf-ha' r301 '/services/asynchronous-operations.html', '/services/api.html#asynchronous-operations' -r301 '/buildpacks/java/build-tool-int.html', '/buildpacks/java/index.html' -r301 '/buildpacks/ruby/ruby-prod-server.html', '/buildpacks/prod-server.html' -r301 '/buildpacks/java/sts.html', '/buildpacks/java/index.html' +r301 '/buildpacks/java/build-tool-int.html', '/buildpacks/classical/java/index.html' +r301 '/buildpacks/ruby/ruby-prod-server.html', '/buildpacks/classical/prod-server.html' +r301 '/buildpacks/java/sts.html', '/buildpacks/classical/java/index.html' r301 '/running/managing-cf/quota-plans.html', '/adminguide/quota-plans.html' r301 '/adminguide/apps-enable-diego.html', '/concepts/diego/diego-architecture.html' @@ -106,8 +106,8 @@ r301 '/services/release-notes.html', 'https://github.com/openservicebrokerapi/servicebroker/blob/v2.12/release-notes.md' r301 '/adminguide/uaa-user-management.html', '/uaa/uaa-user-management.html' -r301 '/buildpacks/detection.html', '/buildpacks/understand-buildpacks.html' -r301 %r{/deploying/cf-release/.*}, '/deploying/cf-release-eol.html' +r301 '/buildpacks/detection.html', '/buildpacks/classical/understand-buildpacks.html' +r301 %r{/deploying/cf-release/.*}, '/deploying/classical/cf-release-eol.html' #OSBAPI Redirects r301 '/services/catalog-metadata.html', 'https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#service-metadata' @@ -121,3 +121,40 @@ # BBR release notes redirect r301 '/bbr/bbr-rn.html', 'https://github.com/cloudfoundry-incubator/bosh-backup-and-restore/releases' + +# r301 '/buildpacks/index.html', '/buildpacks/classical/index.html' # Unsure +r301 '/buildpacks/understand-buildpacks.html', '/buildpacks/classical/understand-buildpacks.html' +r301 '/buildpacks/custom.html', '/buildpacks/classical/custom.html' +r301 '/buildpacks/depend-pkg-offline.html', '/buildpacks/classical/depend-pkg-offline.html' +r301 '/buildpacks/prod-server.html', '/buildpacks/classical/prod-server.html' +r301 '/buildpacks/merging_upstream.html', '/buildpacks/classical/merging_upstream.html' +r301 '/buildpacks/upgrading_dependency_versions.html', '/buildpacks/classical/upgrading_dependency_versions.html' +r301 '/buildpacks/releasing_a_new_buildpack_version.html', '/buildpacks/classical/releasing_a_new_buildpack_version.html' +r301 '/buildpacks/java/index.html', '/buildpacks/classical/java/index.html' +r301 '/buildpacks/java/java-tips.html', '/buildpacks/classical/java/java-tips.html' +r301 '/buildpacks/java/getting-started-deploying-apps/gsg-grails.html', '/buildpacks/classical/java/getting-started-deploying-apps/gsg-grails.html' +r301 '/buildpacks/java/getting-started-deploying-apps/gsg-ratpack.html', '/buildpacks/classical/java/getting-started-deploying-apps/gsg-ratpack.html' +r301 '/buildpacks/java/getting-started-deploying-apps/gsg-spring.html', '/buildpacks/classical/java/getting-started-deploying-apps/gsg-spring.html' +r301 '/buildpacks/java/configuring-service-connections.html', '/buildpacks/classical/java/configuring-service-connections.html' +r301 '/buildpacks/java/java-native-image.html', '/buildpacks/classical/java/java-native-image.html' +r301 '/buildpacks/java/java-client.html', '/buildpacks/classical/java/java-client.html' +r301 '/buildpacks/node/index.html', '/buildpacks/classical/node/index.html' +r301 '/buildpacks/node/node-tips.html', '/buildpacks/classical/node/node-tips.html' +r301 '/buildpacks/node/node-environment.html', '/buildpacks/classical/node/node-environment.html' +r301 '/buildpacks/node/node-service-bindings.html', '/buildpacks/classical/node/node-service-bindings.html' +r301 '/buildpacks/ruby/index.html', '/buildpacks/classical/ruby/index.html' +r301 '/buildpacks/ruby/gsg-ruby.html', '/buildpacks/classical/ruby/gsg-ruby.html' +r301 '/buildpacks/ruby/gsg-ror.html', '/buildpacks/classical/ruby/gsg-ror.html' +r301 '/buildpacks/ruby/sample-ror.html', '/buildpacks/classical/ruby/sample-ror.html' +r301 '/buildpacks/ruby/rake-config.html', '/buildpacks/classical/ruby/rake-config.html' +r301 '/buildpacks/ruby/ruby-tips.html', '/buildpacks/classical/ruby/ruby-tips.html' +r301 '/buildpacks/ruby/ruby-environment.html', '/buildpacks/classical/ruby/ruby-environment.html' +r301 '/buildpacks/ruby/ruby-service-bindings.html', '/buildpacks/classical/ruby/ruby-service-bindings.html' +r301 '/buildpacks/ruby/windows.html', '/buildpacks/classical/ruby/windows.html' +r301 '/buildpacks/go/index.html', '/buildpacks/classical/go/index.html' +r301 '/buildpacks/nginx/index.html', '/buildpacks/classical/nginx/index.html' +r301 '/buildpacks/dotnet-core/index.html', '/buildpacks/classical/dotnet-core/index.html' +r301 '/buildpacks/php/index.html', '/buildpacks/classical/php/index.html' +r301 '/buildpacks/python/index.html', '/buildpacks/classical/python/index.html' +r301 '/buildpacks/staticfile/index.html', '/buildpacks/classical/staticfile/index.html' +r301 '/buildpacks/binary/index.html', '/buildpacks/classical/binary/index.html' From b4ac6abd8b883d41407888bac7303699d877b8f4 Mon Sep 17 00:00:00 2001 From: Pavel Busko Date: Mon, 30 Sep 2024 14:47:30 +0200 Subject: [PATCH 3/3] Adjusted cnb specific documentation Co-authored-by: Ralf Pannemans --- config/template_variables.yml | 6 +- master_middleman/source/index.html.md.erb | 139 +++++++++--------- .../source/subnavs/_cf-subnav.erb | 129 ++++++++-------- redirects.rb | 49 +----- 4 files changed, 142 insertions(+), 181 deletions(-) diff --git a/config/template_variables.yml b/config/template_variables.yml index a7ac6a6e..cb945783 100644 --- a/config/template_variables.yml +++ b/config/template_variables.yml @@ -151,9 +151,9 @@ template_variables: diego_architecture: This topic provides an overview of the structure and components of Diego, the container management system for Cloud Foundry. diego_deploy: To deploy Diego, see the [Cloud Foundry Diego (BOSH release)](https://github.com/cloudfoundry-incubator/diego-release) repository on GitHub. diego_ssh_link: Diego SSH package - disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. + disable_custom_buildpacks_note: Operators can choose to disable custom buildpacks in an entire deployment. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. disable_custom_buildpacks: You can disable custom buildpacks for an entire deployment by adding disable_custom_buildpacks: true in your Cloud Foundry manifest under `properties.cc`. - disable_custom:

    Disabling Custom Buildpacks

    Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. + disable_custom:

    Disabling Custom Buildpacks

    Operators can choose to disable custom buildpacks. For more information, see the [Disabling Custom Buildpacks](../adminguide/buildpacks.html#disabling-custom-buildpacks) section of the _Managing Custom Buildpacks_ topic. docker_auth: To run Docker containers, Cloud Foundry needs the ability to access Docker registries using a Certificate Authority. To configure this access, see [Installing Certificates on VMs](ttps://bosh.io/docs/trusted-certs.html) in the BOSH documentation. domain_name: cloudfoundry.org domains_shared_domains: @@ -193,7 +193,7 @@ template_variables: link_adminguide_buildpack: For more information, see [Managing Custom Buildpacks](../adminguide/buildpacks.html). link_adminguide_commands:

    Note An Org Manager needs explicit admin permissions to perform certain actions. To create a user with admin rights, see Creating and Managing Users with the UAA CLI (UAAC).

    link_adminguide_domains: For admin-specific commands, see [Managing Domains and Routes](../../adminguide/manage-domains-routes.html). - link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, see [Configuring Trusted System Certificates for Applications](../../../running/trusted-system-certificates.html). + link_configure_trusted_certificates: For information about providing trusted certificates to applications running on Cloud Foundry, see [Configuring Trusted System Certificates for Applications](../../running/trusted-system-certificates.html). log_management: logg_forwarding: the [Enabling System Log Forwarding](../running/managing-cf/logging-config.html#syslog-forward) section of the _Configuring System Logging_ topic. logg_scaling: Scaling Loggregator section of the Configuring System Logging topic. diff --git a/master_middleman/source/index.html.md.erb b/master_middleman/source/index.html.md.erb index 92d21168..eab2cf3b 100644 --- a/master_middleman/source/index.html.md.erb +++ b/master_middleman/source/index.html.md.erb @@ -4,8 +4,11 @@ breadcrumb: Cloud Foundry Documentation

    Getting Started with

    - Cloud Foundry Logo -

    Cloud Foundry is an open-source platform as a service (PaaS) that provides you with a choice of clouds, developer frameworks, and application services. + Cloud Foundry Logo +

    Cloud Foundry is an open-source platform as a service (PaaS) that provides you with a + choice of clouds, developer frameworks, and application services.

    @@ -215,7 +218,7 @@ breadcrumb: Cloud Foundry Documentation Using an external filesystem (volume services)
    @@ -223,7 +226,7 @@ breadcrumb: Cloud Foundry Documentation

    - Creating Managed Services in Cloud Foundry

    + Creating Managed Services in Cloud Foundry
    Create and publish free or metered services for Cloud Foundry apps.

    @@ -231,7 +234,7 @@ breadcrumb: Cloud Foundry Documentation Services in Cloud Foundry