Update tox.ini && conf.py file

Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
2024-10-15 13:15:07 +00:00 · 2024-09-06 11:12:36 +00:00 · 2024-04-24 07:54:30 +00:00 · 2024-04-23 13:33:41 +00:00 · 2024-04-23 13:33:38 +00:00 · 2024-04-19 14:27:02 +00:00
14 changed files with 475 additions and 191 deletions
--- a/api-ref/source/_static/.placeholder
+++ b/api-ref/source/_static/.placeholder
--- a/api-ref/source/conf.py
+++ b/api-ref/source/conf.py
--- a/api-ref/source/docutils.conf
+++ b/api-ref/source/docutils.conf
@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top
--- a/api-ref/source/index.rst
+++ b/api-ref/source/index.rst
@ -1,3 +1,4 @@
-==============================================
-Welcome to the documentation of cloud-firewall
-==============================================
+==============================
+Cloud Firewall - API Reference
+==============================
+
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@ -1,4 +1,12 @@
 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
+sphinx-minify>=0.0.1 # Apache-2.0
+git+https://gitea.eco.tsi-dev.otc-service.com/infra/otc-metadata.git#egg=otc_metadata
+setuptools
+gitpython
--- 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
@ -1,3 +1,13 @@
-==============================================
-Welcome to the documentation of cloud-firewall
-==============================================
+Cloud Firewall
+==============
+
+Cloud Firewall (CFW) is a next-generation cloud-native firewall. It protects Internet and VPC borders on the cloud by real-time intrusion detection and prevention, global unified access control, full traffic analysis, log audit, and tracing. It employs AI for intelligent defense, and can be elastically scaled to meet changing business needs, helping you easily handle security threats. CFW is a basic service that provides network security protection for user services on the cloud.
+
+.. directive_wrapper::
+   :class: container-sbv
+
+   .. service_card::
+      :service_type: cfw
+      :environment: internal
+      :umn: This document provides detailed operation guidance of CFW to help you learn and use CFW.
+      :api-ref: This document describes how to use application programming interfaces (APIs) to perform operations on CFW, such as querying and updating.
--- a/tox.ini
+++ b/tox.ini
--- a/umn/source/_static/.placeholder
+++ b/umn/source/_static/.placeholder
--- a/umn/source/conf.py
+++ b/umn/source/conf.py
--- a/umn/source/docutils.conf
+++ b/umn/source/docutils.conf
@ -0,0 +1,2 @@
+[html writers]
+table-style: table, caption-top
--- a/umn/source/index.rst
+++ b/umn/source/index.rst
@ -1,3 +1,4 @@
-==============================================
-Welcome to the documentation of cloud-firewall
-==============================================
+===========================
+Cloud Firewall - User Guide
+===========================
+
--- a/zuul.yaml
+++ b/zuul.yaml
@ -1,3 +1,4 @@
+---
 - project:
    merge-mode: squash-merge
    default-branch: main
Author	SHA1	Message	Date
Gode, Sebastian	69cdce11d3	Update tox.ini && conf.py file Reviewed-by: tischrei <tino.schreiber@t-systems.com> Co-authored-by: Gode, Sebastian <sebastian.gode@t-systems.com> Co-committed-by: Gode, Sebastian <sebastian.gode@t-systems.com>	2024-10-15 13:15:07 +00:00
tischrei	3dd078e8cc	Update tox.ini && conf.py file Co-authored-by: tischrei <tino.schreiber@t-systems.com> Co-committed-by: tischrei <tino.schreiber@t-systems.com>	2024-09-06 11:12:36 +00:00
Hasko, Vladimir	47b077a01e	Update 'doc/source/index.rst' Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>	2024-04-24 07:54:30 +00:00
proposalbot	35ff56f7af	Changes to cfw_umn from docs/doc-exports#1153 (adding cfw service) Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2024-04-23 13:33:41 +00:00
proposalbot	0b95bb14ef	Changes to cfw_api-ref from docs/doc-exports#1153 (adding cfw service) Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>	2024-04-23 13:33:38 +00:00
Hasko, Vladimir	27345ac19d	Update tox.ini && conf.py file Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>	2024-04-19 14:27:02 +00:00