update content

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Goncharov, Artem argoncha <artem.goncharov@t-systems.com>
Co-committed-by: Goncharov, Artem argoncha <artem.goncharov@t-systems.com>

.gitignore

@@ -1 +1,26 @@
-doc/build/**
+_build/
+/AUTHORS
+/ChangeLog
+/dist/
+/otcdocstheme.egg-info/
+.DS_Store
+*.pyc
+doc/build
+doc/source/BBresult
+api-ref/build
+.tox
+/.venv
+*.swp
+*.log
+*.egg*
+
+# Editors
+*~
+
+# Files created by releasenotes build
+releasenotes/build
+
+# Files created by the LaTeX/PDF build
+/.aux
+/.fdb_latexmk
+/texput.fls

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 9136088a246768144165fcc3ecc3d31bb686920a # v3.3.0
+    hooks:
+      - id: trailing-whitespace
+      # Replaces or checks mixed line ending
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      # Forbid files which have a UTF-8 byte-order marker
+      - id: check-byte-order-marker
+      # Checks that non-binary executables have a proper shebang
+      - id: check-executables-have-shebangs
+      # Check for files that contain merge conflict strings.
+      - id: check-merge-conflict
+      # Check for debugger imports and py37+ breakpoint()
+      # calls in python source
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+  - repo: local
+    hooks:
+      - id: flake8
+        name: flake8
+        additional_dependencies:
+          - hacking>=3.0.1,<3.1.0
+        language: python
+        entry: flake8
+        files: '^.*\.py$'
+        exclude: '^(doc|releasenotes|tools)/.*$'

doc/requirements.txt

@@ -7,6 +7,6 @@
 # Put them in here will make it clear that those are only needed for
 # docs.
 
-sphinx==4.0.0
+sphinx>=4.0.0
 otcdocstheme
 reno>=3.1.0 # Apache-2.0

doc/source/_static/images/dt-magenta.svg

@@ -0,0 +1,10 @@
+<svg id="Telekom_Logo" data-name="Telekom Logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 840 1000">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: #e20074;
+      }
+    </style>
+  </defs>
+  <path class="cls-1" d="M200,660H0V460h200V660z M0,0v340h60v-10c0-160,90-260,260-260h10v720c0,100-40,140-140,140h-30v70h520v-70h-30c-100,0-140-40-140-140V70h10c170,0,260,100,260,260v10h60V0H0z M640,660h200V460H640V660z"/>
+</svg>

doc/source/api.rst

@@ -1,5 +1,5 @@
-API
+REST API
-===
+========
 
 .. navigator::
    :class: navigator-container

doc/source/app.rst

@@ -0,0 +1,7 @@
+Application
+===========
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: application_services

doc/source/compute.rst

@@ -1,5 +1,5 @@
-Compute Services
+Compute
-================
+=======
 
 .. service_group::
    :class: service-group

doc/source/conf.py

@@ -20,6 +20,7 @@ extensions = [
 
 # openstackdocstheme options
 otcdocs_repo_name = 'docs/docsportal'
+site_name = "Internal HelpCenter"
 
 # The suffix of source filenames.
 source_suffix = '.rst'
@@ -58,6 +59,7 @@ html_favicon = '_static/favicon.ico'
 html_theme_options = {
     'show_other_versions': False,
     'sidebar_mode': 'toctree',
+    'site_name': 'Internal HelpCenter',
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -86,5 +88,5 @@ latex_documents = [
 
 # -- Intersphinx
 intersphinx_mapping = {
-#    'otce': ('https://docs.otc-service.com/python-otcextensions', None)
+    'security': ('https://docs-beta.otc.t-systems.com/security', None)
 }

doc/source/data_analysis.rst

@@ -0,0 +1,7 @@
+Data Analysis
+=============
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: data_analysis

doc/source/database.rst

@@ -0,0 +1,7 @@
+Database
+========
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: database

doc/source/developer.rst

@@ -9,3 +9,4 @@ Developer
    sdk
    iac
    drivers
+   Blueprints <https://docs-beta.otc.t-systems.com/blueprints>

doc/source/drivers.rst

@@ -1,19 +1,22 @@
 Drivers and Tools
 =================
 
-.. container:: navigator-container
+.. container:: row row-cols-1 row-cols-md-3 g-4
 
    .. container_item::
       :title: CLI
+      :image: _static/images/openstack-logo-vert.png
 
-      - openstack-logo-vert: OpenStack Client|https://docs.openstack.org/python-openstackclient/
+      - OpenStack Client|https://docs.openstack.org/python-openstackclient/
 
    .. container_item::
       :title: Docker
+      :image: _static/images/docker.svg
 
-      - docker: Docker Machine Driver|https://github.com/opentelekomcloud/docker-machine-opentelekomcloud
+      - Docker Machine Driver|https://github.com/opentelekomcloud/docker-machine-opentelekomcloud
 
    .. container_item::
       :title: Rancher
+      :image: _static/images/rancher.svg
 
-      - rancher: Rancher CCE Driver|https://github.com/opentelekomcloud/kontainer-engine-driver-otc
+      - Rancher CCE Driver|https://github.com/opentelekomcloud/kontainer-engine-driver-otc

doc/source/iac.rst

@@ -1,14 +1,16 @@
 Infrastructure As a Code
 ========================
 
-.. container:: navigator-container
+.. container:: row row-cols-1 row-cols-md-3 g-4
 
    .. container_item::
       :title: Ansible
+      :image: _static/images/ansible.svg
 
-      - ansible: Ansible Collection|https://docs.otc-service.com/ansible-collection-cloud
+      - Ansible Collection|https://docs.otc-service.com/ansible-collection-cloud
 
    .. container_item::
       :title: Terraform
+      :image: _static/images/terraform.svg
 
-      - terraform: Open Telekom Cloud Provider|https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs
+      - Open Telekom Cloud Provider|https://registry.terraform.io/providers/opentelekomcloud/opentelekomcloud/latest/docs

doc/source/index.rst

@@ -1,6 +1,6 @@
-================================
+========================================
-Open Telekom Cloud DevOps Portal
+Open Telekom Cloud Service Documentation
-================================
+========================================
 
 .. navigator::
    :class: navigator-container
@@ -13,4 +13,3 @@ Open Telekom Cloud DevOps Portal
    services
    developer
    links
-

doc/source/links.rst

@@ -4,5 +4,6 @@ Quick Links
 .. toctree::
 
    Console <https://console.otc.t-systems.com>
-   Health Dashboard <https://docs.otc.t-systems.com/sd/index.html>
+   Health Dashboard <https://status.otc-service.com>
-   Enterprise Dashboard <https://docs.otc.t-systems.com/ed/index.html>
+   Enterprise Dashboard <https://enterprise-dashboard.otc-service.com>
+   Security advisory <security/index>

doc/source/md.rst

@@ -0,0 +1,7 @@
+Management and Deployment
+=========================
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: md

doc/source/network.rst

@@ -0,0 +1,7 @@
+Network
+=======
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: network

doc/source/sdk.rst

@@ -1,20 +1,23 @@
 SDK
 ===
 
-.. container:: navigator-container
+.. container:: row row-cols-1 row-cols-md-3 g-4
 
    .. container_item::
       :title: Python
+      :image: _static/images/python.svg
 
-      - python: OTC Extensions|https://docs.otc-service.com/python-otcextensions
+      - OTC Extensions|https://docs.otc-service.com/python-otcextensions
 
    .. container_item::
       :title: Golang
+      :image: _static/images/golang.svg
 
-      - golang: Golang SDK|https://github.com/opentelekomcloud/gophertelekomcloud/
+      - Golang SDK|https://github.com/opentelekomcloud/gophertelekomcloud/
 
    .. container_item::
       :title: JavaScript
+      :image: _static/images/javascript.svg
 
-      - javascript: JavaScript SDK|https://github.com/opentelekomcloud/oms/
+      - JavaScript SDK|https://github.com/opentelekomcloud/oms/
 

doc/source/security.rst

@@ -0,0 +1,7 @@
+Security
+========
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: security

doc/source/security/index.rst

@@ -0,0 +1,6 @@
+Security Advisory
+=================
+
+This content will never be shown on real deployment, since we only need a
+redirect to /security, which will be processed by the reverse proxy and serve
+corresponding content.

doc/source/services.rst

@@ -4,3 +4,10 @@ Services
 .. toctree::
 
    compute
+   network
+   storage
+   md
+   security
+   app
+   database
+   data_analysis

doc/source/storage.rst

@@ -0,0 +1,7 @@
+Storage
+=======
+
+.. service_group::
+   :class: service-group
+   :data: services.yaml
+   :category: storage

doc/source/templates/header.html

@@ -1,13 +0,0 @@
-{% if page_source_suffix %}{# an input file was read #}
-<!-- SOURCE_FILE: {% if giturl %}{{giturl}}/{% endif %}{{pagename}}{{page_source_suffix}} -->
-{% else %}{# a template was rendered directly #}
-<!-- TEMPLATE_NAME: {{pagename}} -->
-{% endif %}
-
-<scale-app-shell
-  id="app-shell"
-  claim-lang="en"
-  logo-title="PAGENAME"
-  logo-href="/"
->
-

doc/source/templates/layout.html

@@ -13,27 +13,26 @@
   {%- block relbar1 %}{% endblock %}
 
   {%- block content %}
-      <div class="container docs-book-wrapper">
+      <div class="container-xxl my-md-4 docs-book-wrapper">
-        <div class="row">
+	{% include 'sidebartoc.html' %}
-          <div class="col-lg-9 col-md-8 col-sm-8 col-lg-push-3 col-md-push-4 col-sm-push-4">
+	<div id="content-row" class="row">
-            <div class="row">
+        <main id="docs-main" class="docs-main col-12 col-xl-11" role="main">
-              <div class="col-lg-12">
+          <div id="docs-content" class="docs-content ps-lg-4">
-                <div class="docs-body" role="main">
+            {% block body %}{% endblock %}
-  {% block body %}{% endblock %}
-                </div>
-              </div>
-            </div>
           </div>
-  {% include 'sidebartoc.html' %}
+        </main>
-        </div>
+	</div>
       </div>
   {%- endblock %}
 
   {%- block relbar2 %}{% endblock %}
 
+
+
   {%- block footer %}
   {% include 'footer.html' %}
   {% include 'script_footer.html' %}
   {% block script_footer %}{% endblock %}
   {%- endblock %}
 </div>
+

doc/source/templates/sidebartoc.html

@@ -1,15 +1,15 @@
-<div class="col-lg-3 col-md-4 col-sm-4 col-lg-pull-9 col-md-pull-8 col-sm-pull-8 docs-sidebar">
+<aside id="left-sidebar" class="docs-sidebar">
-    <div class="docs-sidebar-toc">
+  <div class="docs-sidebar-toc collapse" aria-label="Docs navigation" id="docs-sidebar-nav">
-    {%- if theme_display_global_toc_section %}
+  {%- if theme_display_global_toc_section %}
-      <div class="docs-sidebar-section" id="table-of-contents">
+    <div class="docs-sidebar-section" id="table-of-contents">
-        <a href="{{ pathto(master_doc) }}"
+      <a href="{{ pathto(master_doc) }}" class="docs-sidebar-section-title"><h4>Open Telekom Cloud Documentation</h4></a>
-            class="docs-sidebar-section-title"><h4>Open Telekom Cloud Documentation</h4></a>
+      {%- if theme_sidebar_mode == 'toc' %}
-        {%- if theme_sidebar_mode == 'toc' %}
+      {{ toc }}
-        {{ toc }}
+      {%- elif theme_sidebar_mode == 'toctree' %}
-        {%- elif theme_sidebar_mode == 'toctree' %}
+      {{ toctree(maxdepth=2,includehidden=True, collapse=False) }}
-        {{ toctree(maxdepth=2, includehidden=True, collapse=False) }}
+      {%- endif %}
-        {%- endif %}
-      </div>
-    {%- endif %}
     </div>
+  {%- endif %}
   </div>
+</aside>
+

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = docsportal
-summary = OpenTelekomCloud Docs portal
+summary = OpenTelekomCloud Internal Docs portal
 author = Artem Goncharov
 author_email = artem.goncharov@gmail.com
 home_page = https://cloud.otc.com
@@ -19,4 +19,3 @@ classifier =
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Topic :: Documentation
-