Merge pull request #2230 from spryker/rename-cloud-guide

Rename cloud guide

.github/workflows/ci.yml

@@ -61,8 +61,8 @@ jobs:
 
       - run: bundle exec rake check_acp_user
 
-  link_validation_check_cloud:
-    name: Links validation (check_cloud)
+  link_validation_check_ca:
+    name: Links validation (check_ca)
     needs: jekyll_build
     runs-on: ubuntu-latest
 
@@ -87,7 +87,7 @@ jobs:
       - name: Unpack artifacts
         run: tar -xf build-result/result.tar.gz
 
-      - run: bundle exec rake check_cloud
+      - run: bundle exec rake check_ca
 
   link_validation_check_scos_dev:
     name: Links validation (check_scos_dev)
@@ -258,7 +258,7 @@ jobs:
           ruby-version: 2.6
           bundler-cache: true
 
-      - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_cloud_dev.yml
+      - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_ca_dev.yml
         env: # Or as an environment variable
           ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
       - run: bundle exec jekyll algolia --config=_config.yml,algolia_config/_scos_dev.yml

Rakefile

@@ -82,7 +82,7 @@ task :check_acp_user do
   options = commonOptions.dup
   options[:file_ignore] = [
     /docs\/scos\/.+/,
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/fes\/.+/,
     /docs\/scu\/.+/,
     /docs\/pbc\/.+/,
@@ -91,7 +91,7 @@ task :check_acp_user do
   HTMLProofer.check_directory("./_site", options).run
 end
 
-task :check_cloud do
+task :check_ca do
   options = commonOptions.dup
   options[:file_ignore] = [
     /docs\/scos\/.+/,
@@ -108,7 +108,7 @@ end
 task :check_scos_dev do
   options = commonOptions.dup
   options[:file_ignore] = [
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/fes\/.+/,
     /docs\/scu\/.+/,
     /docs\/acp\/.+/,
@@ -131,7 +131,7 @@ end
 task :check_scos_user do
   options = commonOptions.dup
   options[:file_ignore] = [
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/acp\/.+/,
     /docs\/scos\/dev\/.+/,
     /docs\/fes\/.+/,
@@ -155,7 +155,7 @@ task :check_scu do
   options = commonOptions.dup
   options[:file_ignore] = [
     /docs\/scos\/.+/,
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/acp\/.+/,
     /docs\/fes\/.+/,
     /docs\/pbc\/.+/,
@@ -169,7 +169,7 @@ task :check_pbc do
   options[:file_ignore] = [
     /docs\/scos\/.+/,
     /docs\/sdk\/.+/,
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/fes\/.+/,
     /docs\/acp\/.+/,
     /docs\/scu\/.+/,
@@ -186,7 +186,7 @@ task :check_sdk do
   options = commonOptions.dup
   options[:file_ignore] = [
     /docs\/scos\/.+/,
-    /docs\/cloud\/.+/,
+    /docs\/ca\/.+/,
     /docs\/acp\/.+/,
     /docs\/fes\/.+/,
     /docs\/pbc\/.+/,

_config.yml

@@ -111,14 +111,14 @@ defaults:
        role: "dev"
   -
     scope:
-      path: "docs/cloud"
+      path: "docs/ca"
     values:
-      product: "cloud"
+      product: "ca"
   -
     scope:
-      path: "docs/cloud/dev"
+      path: "docs/ca/dev"
     values:
-      sidebar: "cloud_dev_sidebar"
+      sidebar: "ca_dev_sidebar"
       role: "dev"
   -
     scope:
@@ -222,7 +222,7 @@ versioned_categories:
 # these are defaults used for the front matter for these file types
 
 sidebars:
-  - cloud_dev_sidebar
+  - ca_dev_sidebar
   - scos_dev_sidebar
   - scos_user_sidebar
   - sdk_dev_sidebar
@@ -255,8 +255,8 @@ algolia:
       title: 'SCOS Developer'
     - name: 'sdk_dev'
       title: 'SDK Developer'
-    - name: 'cloud_dev'
-      title: 'Cloud Developer'
+    - name: 'ca_dev'
+      title: 'Cloud administration'
     - name: 'acp_user'
       title: 'ACP User'
     - name: 'scu_dev'

_data/sidebars/ca_dev_sidebar.yml

@@ -0,0 +1,159 @@
+title: Cloud administration guide
+entries:
+  - product: Cloud administration
+    nested:
+      - title: Getting started with cloud administration
+        url: /docs/ca/dev/getting-started-with-cloud-administration.html
+      - title: Environments overview
+        url: /docs/ca/dev/environments-overview.html
+      - title: Environments provisioning
+        url: /docs/ca/dev/environment-provisioning.html
+      - title: Access
+        url: /docs/ca/dev/access/access.html
+        nested:
+          - title: Access AWS Management Console
+            url: /docs/ca/dev/access/access-the-aws-management-console.html
+          - title: Locate service credentials
+            url: /docs/ca/dev/access/locate-service-credentials.html
+          - title: Connect to services via SSH
+            url: /docs/ca/dev/access/connect-to-services-via-ssh.html
+      - title: Connecting the Docker SDK
+        url: /docs/ca/dev/connecting-the-docker-sdk.html
+      - title: Connect a code repository
+        url: /docs/ca/dev/connect-a-code-repository.html
+      - title: Set up a custom domain name
+        url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name.html
+        nested:
+          - title: Set up a custom domain name with Route 53
+            url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-route-53.html
+          - title: Set up a custom domain name with a third-party DNS zone provider
+            url: /docs/ca/dev/set-up-a-custom-domain-name/set-up-a-custom-domain-name-with-a-third-party-dns-zone-provider.html
+      - title: Setting up a custom SSL certificate
+        url: /docs/ca/dev/setting-up-a-custom-ssl-certificate.html
+      - title: Deploy in a staging environment
+        url: /docs/ca/dev/deploy-in-a-staging-environment.html
+      - title: Configure debugging
+        url: /docs/ca/dev/configure-debugging.html
+      - title: Working with logs
+        url: /docs/ca/dev/working-with-logs.html
+      - title: Preparation for going live
+        url: /docs/ca/dev/preparation-for-going-live.html
+      - title: Deploy in a production environment
+        url: /docs/ca/dev/deploy-in-a-production-environment.html
+      - title: Starting asynchronous commands
+        url: /docs/ca/dev/starting-asynchronous-commands.html
+      - title: Best practices
+        url: /docs/ca/dev/best-practices/best-practices.html
+        nested:
+        - title: "Best practises: Jenkins stability"
+          url: /docs/ca/dev/best-practices/best-practises-jenkins-stability.html
+      - title: Manage maintenance mode
+        nested:
+          - title: Enable and disable maintenance mode
+            url: /docs/ca/dev/manage-maintenance-mode/enable-and-disable-maintenance-mode.html
+          - title: Configure access to applications in maintenance mode
+            url: /docs/ca/dev/manage-maintenance-mode/configure-access-to-applications-in-maintenance-mode.html
+      - title: Monitoring
+        url: /docs/ca/dev/monitoring/monitoring.html
+        nested:
+          - title: Performance and availability monitoring via New Relic
+            url: /docs/ca/dev/monitoring/performance-and-availability-monitoring-via-new-relic.html
+          - title: Customize AWS CloudWatch dashboards
+            url: /docs/ca/dev/monitoring/customize-aws-cloudwatch-dashboards.html
+      - title: Security
+        url: /docs/ca/dev/security/security.html
+        nested:
+          - title: Check ECR image scan results
+            url: /docs/ca/dev/security/check-ecr-image-scan-results.html
+          - title: Generate access keys
+            url: /docs/ca/dev/security/generate-access-keys.html
+          - title: Web Application Firewall (WAF)
+            url: /docs/ca/dev/security/web-application-firewall-waf.html
+      - title: Configure deployment pipelines
+        url: /docs/ca/dev/configure-deployment-pipelines/configure-deployment-pipelines.html
+        nested:
+          - title: Deployment pipelines
+            url: /docs/ca/dev/configure-deployment-pipelines/deployment-pipelines.html
+          - title: Deployment in states
+            url: /docs/ca/dev/configure-deployment-pipelines/deployment-in-states.html
+          - title: Customize deployment pipelines
+            url: /docs/ca/dev/configure-deployment-pipelines/customize-deployment-pipelines.html
+          - title: Configure Azure Pipelines
+            url: /docs/ca/dev/configure-deployment-pipelines/configure-azure-pipelines.html
+          - title: Configure GitHub Actions
+            url: /docs/ca/dev/configure-deployment-pipelines/configure-github-actions.html
+          - title: Configure GitLab pipelines
+            url: /docs/ca/dev/configure-deployment-pipelines/configure-gitlab-pipelines.html
+          - title: Configure Bitbucket Pipelines
+            url: /docs/ca/dev/configure-deployment-pipelines/configure-bitbucket-pipelines.html
+      - title: Configure data import from an S3 bucket
+        url: /docs/ca/dev/configure-data-import-from-an-s3-bucket.html
+      - title: Create and restore databse backups
+        url: /docs/ca/dev/create-and-restore-database-backups.html
+      - title: Add variables in the Parameter Store
+        url: /docs/ca/dev/add-variables-in-the-parameter-store.html
+      - title: Verify email addresses
+        url: /docs/ca/dev/verify-email-addresses.html
+      - title: Set up notifications for 5xx errors
+        url: /docs/ca/dev/set-up-notifications-for-5xx-errors.html
+      - title: Performance testing in staging environments
+        url: /docs/ca/dev/performance-testing-in-staging-enivronments.html
+      - title: Managing parameters in the Parameter Store
+        url: /docs/ca/dev/managing-parameters-in-the-parameter-store.html
+      - title: Monitoring issues and informing about alerts
+        url: /docs/ca/dev/monitoring-issues-and-informing-about-alerts.html
+      - title: Multi-store setups
+        url: /docs/ca/dev/multi-store-setups/multi-store-setups.html
+        nested:
+          - title: Multistore setup options
+            url: /docs/ca/dev/multi-store-setups/multistore-setup-options.html
+          - title: Add and remove databases of stores
+            url: /docs/ca/dev/multi-store-setups/add-and-remove-databases-of-stores.html
+          - title: Checklist for a new store implementation
+            url: /docs/ca/dev/multi-store-setups/checklist-for-a-new-store-implementation.html
+      - title: Troubleshooting
+        url: /docs/ca/dev/troubleshooting/troubleshooting.html
+        nested:
+          - title: Troubleshooting deployment issues
+            url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/troubleshooting-deployment-issues.html
+            nested:
+              - title: Assets, logs, or pipelines are not visible in AWS Management Console
+                url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/assets-logs-or-pipelines-are-not-visible-in-aws-management-console.html
+              - title: Deployment fails due to a failed docker authentication
+                url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/deployment-fails-due-to-a-failed-docker-authentication.html
+              - title: Jenkins does not restart
+                url: /docs/ca/dev/troubleshooting/troubleshooting-deployment-issues/jenkins-does-not-restart.html
+          - title: Troubleshooting general issues
+            url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/troubleshooting-general-issues.html
+            nested:
+              - title: Changing a source branch fails
+                url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/changing-a-source-branch-fails.html
+              - title: Email address is not verified
+                url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/email-address-is-not-verified.html
+              - title: 'Fatal error: Allowed memory size of x bytes exhausted'
+                url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/fatal-error-allowed-memory-size-of-x-bytes-exhausted.html
+              - title: Missing migration files on production environments
+                url: /docs/ca/dev/troubleshooting/troubleshooting-general-issues/missing-migration-files-on-production-environments.html
+          - title: Troubleshooting tutorials
+            url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/troubleshooting-tutorials.html
+            nested:
+              - title: Troubleshooting a failed deployment
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-failed-deployment.html
+              - title: Troubleshooting a killed process
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-a-killed-process.html
+              - title: Troubleshooting an unavailable Zed
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-an-unavailable-zed.html
+              - title: Troubleshooting failed Jenkins jobs
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failed-jenkins-jobs.html
+              - title: Troubleshooting failing Yves authentication
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-failing-yves-authentication.html
+              - title: Troubleshooting error 403
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-403-error.html
+              - title: Troubleshooting unavailable Yves or Glue
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-unavailable-yves-or-glue.html
+              - title: Troubleshooting Yves or Zed not restarting after deployment
+                url: /docs/ca/dev/troubleshooting/troubleshooting-tutorials/tutorial-troubleshooting-yves-or-zed-not-restarting-after-deployment.html
+      - title: Release notes
+        url: /docs/ca/dev/release-notes.html
+      - title: Spryker Cloud Commerce OS management
+        url: /docs/ca/dev/spryker-cloud-commerce-os-management.html