introduce service based view description

This commit is contained in:
Tino Schreiber 2024-09-26 08:20:50 +00:00
parent ecd76023b9
commit e2e47c51fc
5 changed files with 93 additions and 9 deletions

View File

@ -6,3 +6,4 @@ Helpcenter Operations
:maxdepth: 2
backstage_add_repo
service_based_view

View File

@ -0,0 +1,83 @@
============================
Service Based View knowledge
============================
This document describe necessary knowledge about our Service Based View (SVB)
which is the landing page for the specific service. There you have a short
description of the service and you get all the links for the service
documents.
Service Based View Code Snippets
--------------------------------
The following Code Snippets represents the necessary information which is
needed that SVB can run properly.
Internal SVB Code Snippet
^^^^^^^^^^^^^^^^^^^^^^^^^
.. code::
Cloud Container Engine
======================
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: cce
:environment: internal
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
Public SVB Code Snippet
^^^^^^^^^^^^^^^^^^^^^^^
.. code::
Cloud Container Engine
======================
CCE provides highly scalable, high-performance, enterprise-class Kubernetes clusters. It supports native Kubernetes applications, tools and easy setup of container runtime environment.
.. directive_wrapper::
:class: container-sbv
.. service_card::
:service_type: cce
:umn: Describes the basic concepts, functions, key terms, best practices, FAQs and steps for quickly creating clusters and containerized applications.
:api-ref: Describes the APIs provided by CCE including the functions, parameters, and examples of each API.
:best-practice: To use Cloud Container Engine more securely, reliably, flexibly, and efficiently, you are advised to follow the following best practices.
Documents registration under: `otc_metadata/data/documents <https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata/src/branch/main/otc_metadata/data/documents>`_
Possible Document Names
^^^^^^^^^^^^^^^^^^^^^^^
* api-ref
* blueprints
* caf
* dev
* image-creation-guide
* tool-guide
* mycredential
* public-images
* sdk-ref
* operation-guide
* operation-guide-lts
* parallel-file-system
* permissions-configuration-guide
* permissions
* swiftapi
* s3api
* umn
* umn2
* best-practice
* sqlreference
* guidelines