From 0dc7a4870bc5c02aca031ea4d288f88a0e940280 Mon Sep 17 00:00:00 2001 From: "Goncharov, Artem argoncha" Date: Fri, 22 Jul 2022 16:48:17 +0000 Subject: [PATCH] update content Reviewed-by: gtema Co-authored-by: Goncharov, Artem argoncha Co-committed-by: Goncharov, Artem argoncha --- .gitignore | 27 +++- .pre-commit-config.yaml | 32 +++++ doc/requirements.txt | 2 +- .../_ext/__pycache__/cont.cpython-38.pyc | Bin 6159 -> 6271 bytes doc/source/_ext/cont.py | 125 +++++++++-------- doc/source/_static/css/default.css | 132 +++++------------- doc/source/_static/images/dt-magenta.svg | 10 ++ .../images/services/{sfs.svn => sfs.svg} | 0 doc/source/api.rst | 4 +- doc/source/app.rst | 7 + doc/source/compute.rst | 4 +- doc/source/conf.py | 4 +- doc/source/data_analysis.rst | 7 + doc/source/database.rst | 7 + doc/source/developer.rst | 1 + doc/source/drivers.rst | 11 +- doc/source/iac.rst | 8 +- doc/source/index.rst | 7 +- doc/source/links.rst | 5 +- doc/source/md.rst | 7 + doc/source/network.rst | 7 + doc/source/sdk.rst | 11 +- doc/source/security.rst | 7 + doc/source/security/index.rst | 6 + doc/source/services.rst | 7 + doc/source/services.yaml | 113 ++++++++++++++- doc/source/storage.rst | 7 + doc/source/templates/header.html | 13 -- doc/source/templates/layout.html | 23 ++- doc/source/templates/sidebartoc.html | 26 ++-- setup.cfg | 3 +- 31 files changed, 403 insertions(+), 220 deletions(-) create mode 100644 .pre-commit-config.yaml create mode 100755 doc/source/_static/images/dt-magenta.svg rename doc/source/_static/images/services/{sfs.svn => sfs.svg} (100%) create mode 100644 doc/source/app.rst create mode 100644 doc/source/data_analysis.rst create mode 100644 doc/source/database.rst create mode 100644 doc/source/md.rst create mode 100644 doc/source/network.rst create mode 100644 doc/source/security.rst create mode 100644 doc/source/security/index.rst create mode 100644 doc/source/storage.rst delete mode 100644 doc/source/templates/header.html diff --git a/.gitignore b/.gitignore index 76141c2..c19e2b9 100644 --- a/.gitignore +++ b/.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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..1a96af9 --- /dev/null +++ b/.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)/.*$' diff --git a/doc/requirements.txt b/doc/requirements.txt index 0528130..5eaa903 100644 --- a/doc/requirements.txt +++ b/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 diff --git a/doc/source/_ext/__pycache__/cont.cpython-38.pyc b/doc/source/_ext/__pycache__/cont.cpython-38.pyc index 5d5934fc0e8ea8ca580202b98555ddccfceed402..61fba86a369d59f1fd05a486f67b51d10d9d00ad 100644 GIT binary patch delta 1921 zcma)7&u<$=6yBNLo!!{+#;)Qd7HP9MKN=_5#-R;W!^Th*g@D?$vPac4j>^A0*N~k68}Kd3qlBSKyW}DtP=BP?KCk(h_&YPo0<1! zpXdAD^ZW67+*k+%d=fl!)L6Rv^k>G$2+iu-e$u)GU%EV^Uay;Imm_C0A*~MHRLjp@Gk;ts6U4J zPyUNY=g+hc@a6W{=v`QM1^^^Pkb!(K6hQIOQ4iQyeD;+(A^e;6jbQ~T`$SbRn}U!O z7J%K(WA9y~z5;$HB%$5J}na#(h z+1q9+mvo%zXsVElCLZsYX3JiZ(Uwiq930NBXJXEgfG0z&r2^e*jhliu+bffgUkV3X z9`(`0;IL=J9D96a@@OUyF%F6H9|C=|P5W@$+d7<*BC%sAJ(Xy>vAnH+J*7Srodo;6IK4{7{IBh2@WcxV@{-4R+O3VwuT{1<<|W9sal z4A;<5g3kuibXaOSTJDP;oSPEA5H_r0VZ&U%V4PX%A`U~mB4;gi9W$7gQhidrEq*+vcWskDPZ z)S9!rIm?~kO10c?vclV9SU|XAO&pr*)H-cutTWLB3&G)R6rlEMiwuNBS{6KA{BxyA z`@hj#O~dJ;cxtCTmK*FHQWia=;R(th^1R6FoCqKM59$(j(p+KbW#D19HDAUTL!Erb z==D2kb~~F&JL6@Oe;Vo~6Y*%G7UsVj;i+249xvq*&D4bQ5;fA8?Gorvpbm${MJAU8 z%m@%Q%C7MEu~RC$1U63{8>oH_Mx*TIAe1>qMqMGDIOr9;0;P{pSDm!^u#VdiTLkYG zmW9^D@L2v142qz;dEJi65ouf6k)Y4r1IlI5;iv+AO?5F<8}|LGM9BmBEVM+bf#Vs_ zg#x-DRF6o|3PBajhFM!P%;##*D*UeMH4Ih6ZQ3G&1~Q-`I3X(9BeWTf8WG9!)x=AW z_`d`D9bROoi}`NQte!e5j{mDXk7lpMUW1>_<^f_D{v_n&Mz$O{f8}NKYI-@%()m<6 zhHuEF^?cdC0F0WKlKE0H=QU%N5TRrNu$jK^Yi0N!d*b@T0DtJ>^HwB1+fN)-7@u?Iy2D-umc0<53|p?ka*@WSbr`9a8ns1fOKnMs+3pO>!m_}bfwYs^ z5UsDK#*_4=R>8!#Vp98H;)Cz%gYk9aAD|EFOJiEJuHTtu!CN|;`OP=y{N_97{J!tE zwXvIH(b-5u<=}d7;fLHiNA5*GLTHliqW1gWqd%2y3^P-3JAD8)H-{{44%_^kU?E#v zl8T5vP>*g^MYrgd>!56j#i?@UwToHZI65F_n1W%!jgK-HMvM&dtiYxk85Cr0INJ3F0AQh=Nj1-6!l!kX) z|2-CJl1#q}uSu8_YJxzIMY_@R^kQU)?nc^Q4o!ROs=j|2R&i6$mvW9XnJMQsi-nxK zO0q@QUdfmTB*rxsC(Pb~K>I<*7+sv8Z%4a^jZygikmz+98>Rhp{fJ$hjOp}jB29N&I$C-M;NXMKh_hM9m_a%^lStBqSe!bsXPQ4{XJ)09 z6#Nj&_!0dwc9IThm%4AWnIr&*1O+2ikseAltm5BrO$uv>%+R}9C;FUzqxB#{f7SX^ zQ&*tEP+MsmL19$r3lVBA(~0KAtv#GENi!rPLja!sBwd&k^-^Y-5atuk+;5UoEa?fB zGy-Qgjhwzn?1jmUHxK7+s83%_v^PJk=T}QvXC+$?t~vB>OMm$IKcyM&^%8Z}8<+#x zAhFkEjBb?b5}F?EiYK*cw)ANR%vo+r$Z86FgngNmt*|e{Y~&7K##Z!z5j$YKzt7PA#b_>YJNOvbHv^W$jAXU6agZtw z5o`pa*7}m`pTK;ArC!$|O41Ko+qY8FAW=hbXOd`eaBti++}zcY-S9yDCBW>}Rbtu1 zw)Fbz;_9YN8eI}pHL$Z_xWx1f!?g~}31(`P5{e9Z>kgq`v~+A8{aZ2rk3K$@2@1(v zWsE|~DxX^`Lg%pT2c477n5W)&ML%aR!1l^{+Zbg%02D725Lr0KZ>*HPWX7BYAL?gw z<&9j)C^U#wu~aNCJ5_#zl*l#n)7G$vfB)~h2JM%wNsN+p zp5)Jo8OTH=2A3H`7|heYl!+g6bRji>Y 1 else key + href = data_parts[1] if len(data_parts) > 1 else '#' services.append( dict( - key=key, title=title, href=href ) @@ -153,50 +152,64 @@ class ContainerItem(Directive): def container_item_html(self, node): - tmpl = """ -
-

%(title)s

+ tmpl = f""" +
+
+ %(img)s +
+
%(title)s
+
%(data)s +
""" node['data'] = ( - "") + node['img'] = '' + if 'image' in node and node['image']: + node['img'] = ( + f'' + ) self.body.append(tmpl % node) raise nodes.SkipNode def navigator_html(self, node): - data = f'
' + # This method renders containers of service groups with links to the + # document of the specified type + data = f'
' for k, v in node['data']['service_categories'].items(): data += ( - f'
' - f"

{v['title']}

    " + f'
    ' + f'
    ' + f'
    {v["title"]}
    ' + f'
      ' ) for srv_k, srv_v in v['services'].items(): - link = srv_v.get(node["link_type"], srv_k) + # if service has no proper link for the type - skip it + link = srv_v.get(node["link_type"], None) + if not link: + continue img = srv_k title = srv_v["title"] data += ( - f'
    • ' + f'
    • ' f'
      ' - f'
      ' + f'
      ' f'' f'
      ' - f'
      {title}
      ' + f'
      {title}
      ' f'
      • ' ) - data += '
    ' + data += '
' data += '
' @@ -205,47 +218,45 @@ def navigator_html(self, node): def service_group_html(self, node): - data = f'
' + # This method renders containers per each service of the category with all + # links as individual list items + data = '
' for k, v in node['data']['services'].items(): - img = k title = v["title"] - data += '
' - # 1st column - title data += ( - f'' - ) - # 3rd column - API-Ref - link = v.get("api") - data += ( - f'' - ) if link else ( - f'' - ) - # 4th column - UMN - link = v.get("umn") - data += ( - f'' - ) if link else ( - f'' + f'
' + f'
' + f'{v["title"]}
' + f'
    ' ) + # API-Ref and UMN + # NOTE(gtema): maybe we want some special icons + for doc_type in [ + ('api', 'API Reference'), + ('umn', 'User Manual') + ]: + link = v.get(doc_type[0]) + if link: + title = doc_type[1] + data += ( + f'
  • ' + f'
    ' + f'
    {title}
    ' + f'
    • ' + ) + # all other links for link in v.get("links", []): data += ( - f'
' + f'
  • ' + f'
    ' + f'
    {link["title"]}
    ' + f'
    • ' ) # Row end - data += '' - data += "
    ' - f'' - f'
    ' - f'{title}
    ' - f'    		' - f'API Reference' - f'' - f'User Manual' - f'' - f'{link["title"]}' - f'
    " + data += '
    ' + data += '' + self.body.append(data) raise nodes.SkipNode diff --git a/doc/source/_static/css/default.css b/doc/source/_static/css/default.css index 996f766..9bdd539 100644 --- a/doc/source/_static/css/default.css +++ b/doc/source/_static/css/default.css @@ -1,107 +1,49 @@ -.docs-book-wrapper { - margin-top: 0 !important; +/* Limit image in the card title*/ +.card-img-top { + max-width: 4rem; + height: 4rem; + padding-top: 5px; } -scale-app-shell div.container { - margin-left: unset; - margin-right: unset; +/* decorate links in card */ +.card a { + text-decoration: none; +} +.card li:hover { + background: lightgray; +} +.card-title { + font-weight: unset; } -@media (min-width: 1600px) { - .container { - width: 100% !important; - padding-left: 0 !important; +/* Special boxes for cards */ +.card { + box-shadow: 0px 2px 10px 1px rgba(0,0,0,0.2); + transition: transform .2s; +} + +.card:hover { + box-shadow: 0px 2px 15px 1px rgba(0,0,0,0.3); +} + +/* on large screen we want card to be approx of the same size */ +@media (min-width:768px) { + .navigator-container .card { + min-height: 300px; } + /* disable push to bottom on the card */ + .navigator-container .card .card-body { + flex: unset; + } + } -.service-box { - border: 1px solid #E8E8E8; - padding: 30px 20px; - border-radius: 4px; - min-height: 200px; - max-width: 300px; - margin-right: 20px !important; - margin-bottom: 20px; - display: flex; - justify-content: center; -} - -.service-box:hover { - box-shadow: 0 0 6px rgba(35, 173, 278, 1); -} - -.service-box ul { - list-style-type: none; -} - -.navigator-container { - display: flex; - flex-wrap: wrap; - flex-direction: row; - justify-content: flex-start; - padding: 0; - margin: 0; - list-style: none; - } - -.navigator-item { - padding: 10px; - margin: 10px; - background: white; - width: 300px; - min-height: 200px; - color: #191919; - text-align: left; - box-shadow: 0px 2px 10px 1px rgba(0,0,0,0.2); - transition: transform .2s; -} - -.navigator-item > p { - text-align: justify; -} - -.navigator-item > h3 { - margin-top: 10px; - text-align: right; -} - -.navigator-item > img { - height: 4em; -} - -.navigator-item > ul { - list-style-type: none; - padding-left: 10px; -} - -//.navigator-item > ul > li { -// margin-bottom: 10px; -// padding: 5px; -//} -.navigator-item > ul > li:hover { - background: lightgray; -} - -.navigator-item:hover { - // transform: scale(1.05); - box-shadow: 0px 2px 15px 1px rgba(0,0,0,0.3); -} - -.navigator-item > ul > li > a > div > div > img { +/* limit icon size in the card li */ +.navigator-container .card > ul > li > a > div > div > img { max-height: 20px; max-width: 20px; } -.navigator-container a { - color: #191919 !important; -} - -.navigator-container a:hover { - text-decoration: none; - background: gray; -} - -.service-group img { - max-width: 48px; - max-height: 48px; +.navigator-container .card li { + padding: 0.2rem 1rem; } diff --git a/doc/source/_static/images/dt-magenta.svg b/doc/source/_static/images/dt-magenta.svg new file mode 100755 index 0000000..7fb183d --- /dev/null +++ b/doc/source/_static/images/dt-magenta.svg @@ -0,0 +1,10 @@ + diff --git a/doc/source/_static/images/services/sfs.svn b/doc/source/_static/images/services/sfs.svg similarity index 100% rename from doc/source/_static/images/services/sfs.svn rename to doc/source/_static/images/services/sfs.svg diff --git a/doc/source/api.rst b/doc/source/api.rst index 3997632..8aa42d7 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -1,5 +1,5 @@ -API -=== +REST API +======== .. navigator:: :class: navigator-container diff --git a/doc/source/app.rst b/doc/source/app.rst new file mode 100644 index 0000000..7b72436 --- /dev/null +++ b/doc/source/app.rst @@ -0,0 +1,7 @@ +Application +=========== + +.. service_group:: + :class: service-group + :data: services.yaml + :category: application_services diff --git a/doc/source/compute.rst b/doc/source/compute.rst index 0957a34..10751d5 100644 --- a/doc/source/compute.rst +++ b/doc/source/compute.rst @@ -1,5 +1,5 @@ -Compute Services -================ +Compute +======= .. service_group:: :class: service-group diff --git a/doc/source/conf.py b/doc/source/conf.py index fbdb637..2fb3c0c 100644 --- a/doc/source/conf.py +++ b/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) } diff --git a/doc/source/data_analysis.rst b/doc/source/data_analysis.rst new file mode 100644 index 0000000..9b3ca5d --- /dev/null +++ b/doc/source/data_analysis.rst @@ -0,0 +1,7 @@ +Data Analysis +============= + +.. service_group:: + :class: service-group + :data: services.yaml + :category: data_analysis diff --git a/doc/source/database.rst b/doc/source/database.rst new file mode 100644 index 0000000..3cc96d9 --- /dev/null +++ b/doc/source/database.rst @@ -0,0 +1,7 @@ +Database +======== + +.. service_group:: + :class: service-group + :data: services.yaml + :category: database diff --git a/doc/source/developer.rst b/doc/source/developer.rst index fc51f4f..491f25b 100644 --- a/doc/source/developer.rst +++ b/doc/source/developer.rst @@ -9,3 +9,4 @@ Developer sdk iac drivers + Blueprints diff --git a/doc/source/drivers.rst b/doc/source/drivers.rst index 35910b1..181f632 100644 --- a/doc/source/drivers.rst +++ b/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 diff --git a/doc/source/iac.rst b/doc/source/iac.rst index 1c1740f..bd99e7f 100644 --- a/doc/source/iac.rst +++ b/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 diff --git a/doc/source/index.rst b/doc/source/index.rst index 3c88261..c7514d7 100644 --- a/doc/source/index.rst +++ b/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 - diff --git a/doc/source/links.rst b/doc/source/links.rst index 6f20115..6a9129a 100644 --- a/doc/source/links.rst +++ b/doc/source/links.rst @@ -4,5 +4,6 @@ Quick Links .. toctree:: Console - Health Dashboard - Enterprise Dashboard + Health Dashboard + Enterprise Dashboard + Security advisory diff --git a/doc/source/md.rst b/doc/source/md.rst new file mode 100644 index 0000000..ee6d64b --- /dev/null +++ b/doc/source/md.rst @@ -0,0 +1,7 @@ +Management and Deployment +========================= + +.. service_group:: + :class: service-group + :data: services.yaml + :category: md diff --git a/doc/source/network.rst b/doc/source/network.rst new file mode 100644 index 0000000..4bbb278 --- /dev/null +++ b/doc/source/network.rst @@ -0,0 +1,7 @@ +Network +======= + +.. service_group:: + :class: service-group + :data: services.yaml + :category: network diff --git a/doc/source/sdk.rst b/doc/source/sdk.rst index 8f35d87..2b94972 100644 --- a/doc/source/sdk.rst +++ b/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/ diff --git a/doc/source/security.rst b/doc/source/security.rst new file mode 100644 index 0000000..b83a395 --- /dev/null +++ b/doc/source/security.rst @@ -0,0 +1,7 @@ +Security +======== + +.. service_group:: + :class: service-group + :data: services.yaml + :category: security diff --git a/doc/source/security/index.rst b/doc/source/security/index.rst new file mode 100644 index 0000000..738500e --- /dev/null +++ b/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. diff --git a/doc/source/services.rst b/doc/source/services.rst index e87ffa9..a159d2e 100644 --- a/doc/source/services.rst +++ b/doc/source/services.rst @@ -4,3 +4,10 @@ Services .. toctree:: compute + network + storage + md + security + app + database + data_analysis diff --git a/doc/source/services.yaml b/doc/source/services.yaml index 51806a0..e5bbd93 100644 --- a/doc/source/services.yaml +++ b/doc/source/services.yaml @@ -14,7 +14,6 @@ service_categories: title: Bare Metal Server api: https://docs.otc.t-systems.com/en-us/api/bms/en-us_topic_0143138428.html umn: https://docs.otc.t-systems.com/en-us/usermanual/bms/en-us_topic_0053536919.html - dev: https://docs.otc.t-systems.com/en-us/devg/bms/en-us_topic_0113605684.html links: - url: https://docs.otc.t-systems.com/en-us/devg/bms/en-us_topic_0113605684.html title: Developer Guide @@ -30,10 +29,10 @@ service_categories: umn: https://docs.otc.t-systems.com/usermanual/deh/deh_01_0003.html ecs: title: Elastic Cloud Server - api: https://docs.otc.t-systems.com/en-us/api/ecs/en-us_topic_0020805967.html - umn: https://docs.otc.t-systems.com/en-us/usermanual/ecs/en-us_topic_0092494580.html + api: https://docs-beta.otc.t-systems.com/api-ref/elastic-cloud-server/ + umn: https://docs-beta.otc.t-systems.com/umn/elastic-cloud-server/ links: - - url: https://docs.otc.t-systems.com/en-us/devg/ecs/en-us_topic_0134192990.html + - url: https://docs-beta.otc.t-systems.com/dev/elastic-cloud-server/ title: Developer Guide ims: title: Image Management Service @@ -50,24 +49,44 @@ service_categories: services: cbr: title: Cloud Backup and Recovery + api: https://docs.otc.t-systems.com/api/cbr/cbr_04_0001.html umn: https://docs.otc.t-systems.com/en-us/usermanual/cbr/cbr_01_0001.html csbs: title: Cloud Server Backup Service + api: https://docs.otc.t-systems.com/en-us/api/csbs/en-us_topic_0061309751.html umn: https://docs.otc.t-systems.com/en-us/usermanual/csbs/en-us_topic_0056584625.html evs: title: Elastic Volume Service + api: https://docs.otc.t-systems.com/en-us/api/evs/evs_04_0001.html umn: https://docs.otc.t-systems.com/en-us/usermanual/evs/evs_01_0119.html + links: + - url: https://docs.otc.t-systems.com/en-us/devg/evs/evs_03_0001.html + title: Developer Guide obs: title: Object Storage Service + api: https://docs.otc.t-systems.com/api/obs/en-us_topic_0031051947.html umn: https://docs.otc.t-systems.com/usermanual/obs/en-us_topic_0045853692.html + links: + - url: https://docs.otc.t-systems.com/ugs3cmd/obs/en-us_topic_0051518473.html + title: Third-party client (s3cmd) + - url: https://docs.otc.t-systems.com/api_swift/obs/obs_03_0001.html + title: Swift API reference + - url: https://docs.otc.t-systems.com/api_obs/obs/en-us_topic_0031665984.html + title: S3 API reference sdrs: title: Storage Disaster Recovery Service + api: https://docs.otc.t-systems.com/en-us/api/sdrs/sdrs_01_0000.html umn: https://docs.otc.t-systems.com/en-us/usermanual/sdrs/sdrs_pro_0000.html sfs: title: Scalable File Service + api: https://docs.otc.t-systems.com/en-us/api/sfs/sfs_02_0001.html umn: https://docs.otc.t-systems.com/en-us/usermanual/sfs/en-us_topic_0034428718.html + links: + - url: https://docs.otc.t-systems.com/en-us/api_cli/sfs/sfs_04_0001.html + title: Manila client reference vbs: title: Volume Backup Service + api: https://docs.otc.t-systems.com/en-us/api/vbs/en-us_topic_0061309333.html umn: https://docs.otc.t-systems.com/en-us/usermanual/vbs/en-us_topic_0015667845.html network: @@ -75,88 +94,174 @@ service_categories: services: cdn: title: Content Delivery Network (Akamai) + umn: https://docs.otc.t-systems.com/cdn/doc/download/pdf/cdn-usermanual.pdf dc: title: Direct Connect + api: https://docs.otc.t-systems.com/api/dc/en-dc_topic_0055025300.html + umn: https://docs.otc.t-systems.com/usermanual/dc/en-us_topic_0032025288.html dns: title: Domain Name Service + api: https://docs.otc.t-systems.com/en-us/api/dns/dns_api_50000.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/dns/en-us_topic_0035467691.html elb: title: Elastic Load Balancing api: https://docs.otc-service.com/api-ref/elastic-load-balancing/ umn: https://docs.otc-service.com/umn/elastic-load-balancing/ eip: title: Elastic IP + api: https://docs.otc.t-systems.com/api/eip/eip_api01_0000.html + umn: https://docs.otc.t-systems.com/usermanual/eip/overview.html nat: title: NAT Gateway + api: https://docs.otc.t-systems.com/api/nat/nat_api_0047.html + umn: https://docs.otc.t-systems.com/usermanual/nat/nat_pro_0000.html plas: title: Private Link Access Service + api: https://docs.otc.t-systems.com/en-us/api/plas/en-us_topic_0218811267.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/plas/en-us_topic_0218777868.html + links: + - url: https://docs.otc.t-systems.com/en-us/plas/doc/download/excel/plas-ot.xlsm + title: Order form template vpc: title: Virtual Private Cloud + api: https://docs.otc.t-systems.com/api/vpc/en-us_topic_0050065465.html + umn: https://docs.otc.t-systems.com/usermanual/vpc/en-us_topic_0013748729.html vpc_ep: title: VPC Endpoint + api: https://docs.otc.t-systems.com/api/vpcep/vpcep_05_0000.html + umn: https://docs.otc.t-systems.com/usermanual/vpcep/en-us_topic_0131645194.html vpn: title: Virtual Private Network + api: https://docs.otc.t-systems.com/api/vpn/en_topic_0093011471.html + umn: https://docs.otc.t-systems.com/usermanual/vpn/en-us_topic_0035391332.html md: title: Management & Deployment services: ces: title: Cloud Eye + api: https://docs.otc.t-systems.com/api/ces/ces_03_0001.html + umn: https://docs.otc.t-systems.com/usermanual/ces/en-us_topic_0015479882.html cts: title: Cloud Trace Service + api: https://docs.otc.t-systems.com/en-us/api/cts/en-us_topic_0168602179.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/cts/en-us_topic_0030579718.html iam: title: Identity and Access Management + api: https://docs.otc.t-systems.com/en-us/api/iam/iam_02_0017.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/iam/iam_01_0026.html lts: title: Log Tank Service + api: https://docs.otc.t-systems.com/api/lts/lts_02_0001.html + umn: https://docs.otc.t-systems.com/usermanual/lts/lts_01_0001.html rts: title: Resource Template Service + api: https://docs.otc.t-systems.com/api/rts/en-us_topic_0082242144.html + umn: https://docs.otc.t-systems.com/usermanual/rts/rts_01_0001.html tms: title: Tag Management Service + api: https://docs.otc.t-systems.com/api/tms/en-us_topic_0056283725.html + umn: https://docs.otc.t-systems.com/usermanual/tms/en-us_topic_0056095606.html security: title: Security services: anti_ddos: title: Anti-DDoS + api: https://docs.otc.t-systems.com/en-us/api/antiddos/en-us_topic_0037386201.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/antiddos/en-us_topic_0023977447.html kms: title: Key Management Service + api: https://docs.otc.t-systems.com/en-us/api/kms/en-us_topic_00384375969.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/kms/en-us_topic_0034324884.html vd: title: Vulnerability Database umn: https://nvd.nist.gov/ waf: title: Web Application Firewall + api: https://docs.otc.t-systems.com/api/waf/waf_02_0001.html + umn: https://docs.otc.t-systems.com/usermanual/waf/waf_01_0045.html application_services: title: Application Services services: aom: title: Application Operations Management + api: https://docs.otc.t-systems.com/api/aom/aom_04_0000.html + umn: https://docs.otc.t-systems.com/usermanual/aom/aom_02_1007.html dms: title: Distributed Message Service + api: https://docs.otc.t-systems.com/en-us/api/dms/en-us_topic_0036182510.html + umn: https://docs.otc.t-systems.com/en-us/usermanual/dms/en-us_topic_0044827396.html + links: + - url: https://docs.otc.t-systems.com/en-us/devg/dms/Kafka-summary.html + title: Development Guide smn: title: Simple Message Notification + api: https://docs.otc.t-systems.com/api/smn/en-us_topic_0036017316.html + umn: https://docs.otc.t-systems.com/usermanual/smn/en-us_topic_0043394885.html swr: title: Software Repository for Container + api: https://docs.otc.t-systems.com/api/swr/swr_02_0078.html + umn: https://docs.otc.t-systems.com/usermanual/swr/swr_03_0001.html database: title: Database services: dcs: title: Distributed Cache Service + api: https://docs.otc.t-systems.com/api/dcs/dcs-api-0417001.html + umn: https://docs.otc.t-systems.com/usermanual/dcs/en-us_topic_0054235826.html dds: title: Document Database Service + api: https://docs.otc.t-systems.com/api/dds/dds_api_reference.html + umn: https://docs.otc.t-systems.com/usermanual/dds/en-us_topic_user_guide.html rds: title: Relational Database Service + api: https://docs.otc.t-systems.com/api/rds/en-us_topic_0032347780.html + umn: https://docs.otc.t-systems.com/usermanual/rds/rds_01_0000.html data_analysis: title: Data Analysis services: css: title: Cloud Search Service + api: https://docs.otc.t-systems.com/api/css/css_03_0001.html + umn: https://docs.otc.t-systems.com/usermanual/css/css_04_0001.html dis: title: Data Ingestion Service + api: https://docs.otc.t-systems.com/api/dis/en-us_topic_0057474833.html + umn: https://docs.otc.t-systems.com/usermanual/dis/en-us_topic_0033058843.html dws: title: Data Warehouse Service + api: https://docs.otc.t-systems.com/api/dws/dws_02_0033.html + umn: https://docs.otc.t-systems.com/usermanual/dws/dws_01_0002.html + links: + - url: https://docs.otc.t-systems.com/devg/dws/dws_04_0001.html + title: Developer Guide + - url: https://docs.otc.t-systems.com/tg/dws/dws_07_0001.html + title: Tool Guide + - url: https://docs.otc.t-systems.com/fcode/dws/dws_08_0001.html + title: Error Code Reference mrs: title: MapReduce Service + api: https://docs.otc.t-systems.com/api/mrs/en-us_topic_0037324628.html + umn: https://docs.otc.t-systems.com/usermanual/mrs/mrs_08_0001.html + links: + - url: https://docs.otc.t-systems.com/cmpntguide/mrs/mrs_01_0756.html + title: Operation Guide ma: title: ModelArts + api: https://docs-beta.otc.t-systems.com/api-ref/modelarts/ + umn: https://docs-beta.otc.t-systems.com/umn/modelarts/ + + others: + title: Others + services: + psd: + title: Status Dashboard + umn: https://docs.otc.t-systems.com/sd/index.html + edb: + title: Enterprise Dashboard + api: https://docs-beta.otc.t-systems.com/api-ref/enterprise-dashboard/ + umn: https://docs-beta.otc.t-systems.com/umn/enterprise-dashboard/ diff --git a/doc/source/storage.rst b/doc/source/storage.rst new file mode 100644 index 0000000..b4f6f1d --- /dev/null +++ b/doc/source/storage.rst @@ -0,0 +1,7 @@ +Storage +======= + +.. service_group:: + :class: service-group + :data: services.yaml + :category: storage diff --git a/doc/source/templates/header.html b/doc/source/templates/header.html deleted file mode 100644 index 2c38755..0000000 --- a/doc/source/templates/header.html +++ /dev/null @@ -1,13 +0,0 @@ -{% if page_source_suffix %}{# an input file was read #} - -{% else %}{# a template was rendered directly #} - -{% endif %} - - - diff --git a/doc/source/templates/layout.html b/doc/source/templates/layout.html index 047025b..0325169 100644 --- a/doc/source/templates/layout.html +++ b/doc/source/templates/layout.html @@ -13,27 +13,26 @@ {%- block relbar1 %}{% endblock %} {%- block content %} -
    -
    -
    -
    -
    -
    - {% block body %}{% endblock %} -
    -
    -
    +
    + {% include 'sidebartoc.html' %} +
    +
    +
    + {% block body %}{% endblock %}
    - {% include 'sidebartoc.html' %} -
    + +
    {%- endblock %} {%- block relbar2 %}{% endblock %} + + {%- block footer %} {% include 'footer.html' %} {% include 'script_footer.html' %} {% block script_footer %}{% endblock %} {%- endblock %}
    + diff --git a/doc/source/templates/sidebartoc.html b/doc/source/templates/sidebartoc.html index e7ea5dc..80a0099 100644 --- a/doc/source/templates/sidebartoc.html +++ b/doc/source/templates/sidebartoc.html @@ -1,15 +1,15 @@ -
    -
    - {%- if theme_display_global_toc_section %} -
    -

    Open Telekom Cloud Documentation

     - {%- if theme_sidebar_mode == 'toc' %} - {{ toc }} - {%- elif theme_sidebar_mode == 'toctree' %} - {{ toctree(maxdepth=2, includehidden=True, collapse=False) }} - {%- endif %} -
    - {%- endif %} + + diff --git a/setup.cfg b/setup.cfg index 249becc..6063728 100644 --- a/setup.cfg +++ b/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 -