Update 'doc/source/index.rst'

Add Service-Based-View to the service
2023-05-12 07:47:27 +00:00 · 2023-05-08 14:51:58 +02:00
9 changed files with 134 additions and 5 deletions
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
@ -18,7 +18,7 @@ import os
 import sys

 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]

 otcdocs_auto_name = False
--- a/doc/component-operation-guide-lts/source/conf.py
+++ b/doc/component-operation-guide-lts/source/conf.py
@ -18,7 +18,7 @@ import os
 import sys

 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]

 otcdocs_auto_name = False
--- a/doc/component-operation-guide/source/conf.py
+++ b/doc/component-operation-guide/source/conf.py
@ -18,7 +18,7 @@ import os
 import sys

 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]

 otcdocs_auto_name = False
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@ -2,3 +2,6 @@ sphinx>=2.0.0,!=2.1.0 # BSD
 otcdocstheme # Apache-2.0
 # releasenotes
 reno>=3.1.0 # Apache-2.0
+
+otc-sphinx-directives>=0.1.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
--- a/doc/source/_static/placeholder
+++ b/doc/source/_static/placeholder
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@ -0,0 +1,15 @@
+MapReduce Service
+=================
+
+MapReduce Service (MRS) provides enterprise-level big data clusters on the cloud, which are fully controlled by tenants and support the Hadoop, Spark, HBase, Kafka, and Storm components.
+
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: mrs
+      :umn: This document provides detailed operation guidance of MRS to help you learn and use MRS.
+      :api-ref: This document introduces API reference provided by MRS and describes functions and parameters of each API.
+      :operation-guide: This document describes how to use big data components in MRS to easily run the components for big data analysis and processing.
+      :operation-guide-lts: This document describes how to use the big data components in the MRS cluster of the LTS version to easily run the big data analysis and processing components.
--- a/tox.ini
+++ b/tox.ini
@ -29,7 +29,11 @@ allowlist_externals =
  mkdir
  cp
  sh
+  rm
+  sphinx-build
 commands =
+  rm -rf doc/build/html doc/build/doctrees
+  sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
  {[testenv:api-ref]commands}
  {[testenv:json-api-ref]commands}
  {[testenv:operation-guide]commands}
@ -226,3 +230,8 @@ commands =
  mkdir -p doc/build/pdf
  cp umn/build/pdf/mrs-umn.pdf doc/build/pdf/

+
+
+[doc8]
+ignore = D001
+extensions = .rst, .yaml
--- a/umn/source/conf.py
+++ b/umn/source/conf.py
@ -18,7 +18,7 @@ import os
 import sys

 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]

 otcdocs_auto_name = False
Author	SHA1	Message	Date
Kacur, Michal	7738c13079	Update 'doc/source/index.rst'	2023-05-12 07:47:27 +00:00
SebastianGode	865c85b52d	Add Service-Based-View to the service	2023-05-08 14:51:58 +02:00