modifying index.rst file

revert Modified index.rst file

api-ref/source/appendix/index.rst

@@ -1,16 +0,0 @@
-:original_name: aos_02_0040.html
-
-.. _aos_02_0040:
-
-Appendix
-========
-
--  :ref:`Status Code <aos_02_0041>`
--  :ref:`Error Codes <errorcode>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   status_code
-   error_codes

api-ref/source/before_you_start/concepts.rst

@@ -1,38 +0,0 @@
-:original_name: aos_02_0055.html
-
-.. _aos_02_0055:
-
-Concepts
-========
-
--  Account
-
-   An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.
-
--  Domain
-
-   A domain is created upon successful registration. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity, which should not be used directly to perform routine management. For security purposes, create Identity and Access Management (IAM) users and grant them permissions for routine management.
-
--  User
-
-   An IAM user is created by an account in IAM to use cloud services. Each IAM user has its own identity credentials (password and access keys).
-
-   API authentication requires information such as the domain name, username, and password.
-
--  Region
-
-   A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.
-
--  AZ
-
-   An AZ comprises of one or more physical data centers equipped with independent ventilation, fire, water, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow you to build cross-AZ high-availability systems.
-
--  Project
-
-   A project corresponds to a region. Default projects are defined to group and physically isolate resources (including computing, storage, and network resources) across regions. Users can be granted permissions in a default project to access all resources under their domains in the region associated with the project. If you need more refined access control, create subprojects under a default project and create resources in subprojects. Then you can assign users the permissions required to access only the resources in the specific subprojects.
-
-
-   .. figure:: /_static/images/en-us_image_0000001893402049.png
-      :alt: **Figure 1** Project isolation model
-
-      **Figure 1** Project isolation model

api-ref/source/before_you_start/index.rst

@@ -1,16 +0,0 @@
-:original_name: aos_02_0000.html
-
-.. _aos_02_0000:
-
-Before You Start
-================
-
--  :ref:`Overview <aos_02_0001>`
--  :ref:`Concepts <aos_02_0055>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   overview
-   concepts

api-ref/source/before_you_start/overview.rst

@@ -1,14 +0,0 @@
-:original_name: aos_02_0001.html
-
-.. _aos_02_0001:
-
-Overview
-========
-
-Resource Formation Service (RFS) provides the latest :ref:`resource formation APIs <rfs_02_0000>`.
-
-RFS is a new final-state resource formation engine for cloud services and fully supports Terraform (HCL and Provider), which is a de facto standard. It is an upgrade of the Application Orchestration Service (AOS) in terms of the ecosystem, experience, and features. Based on HCL syntax template, RFS automatically builds cloud service resources in batches to help you create, manage, and upgrade cloud service resources in an efficient, secure, and consistent manner, improving resource management efficiency and reducing security risks caused by resource management changes.
-
-This document describes how to use APIs to perform operations on RFS, such as template creation, deletion, and query.
-
-Before calling RFS APIs, ensure that you are familiar with RFS concepts. For details, see Service Overview.

api-ref/source/change_history.rst

@@ -1,12 +0,0 @@
-:original_name: aos_02_0070.html
-
-.. _aos_02_0070:
-
-Change History
-==============
-
-========== ==============
-Date       Change History
-========== ==============
-2024-07-30 First release
-========== ==============

api-ref/source/conf.py

@@ -106,6 +106,7 @@ html_title = "Resource Formation Service - API Reference"
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
+templates_path = ['_templates']
 
 # Do not include sources into the rendered results
 html_copy_source = False

api-ref/source/index.rst

@@ -1,11 +1,3 @@
-==========================================
-Resource Formation Service - API Reference
-==========================================
-
-.. toctree::
-   :maxdepth: 1
-
-   before_you_start/index
-   resource_formation_service/index
-   appendix/index
-   change_history
+==========================================================
+Welcome to the documentation of resource-formation-service
+==========================================================

api-ref/source/resource_formation_service/execution_plans/index.rst

@@ -1,24 +0,0 @@
-:original_name: topic_300000001.html
-
-.. _topic_300000001:
-
-Execution Plans
-===============
-
--  :ref:`Listing Execution Plans <listexecutionplans>`
--  :ref:`Creating an Execution Plan <createexecutionplan>`
--  :ref:`Obtaining Execution Plans <getexecutionplan>`
--  :ref:`Applying an Execution Plan <applyexecutionplan>`
--  :ref:`Deleting an Execution Plan <deleteexecutionplan>`
--  :ref:`Obtaining Execution Plan Metadata <getexecutionplanmetadata>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   listing_execution_plans
-   creating_an_execution_plan
-   obtaining_execution_plans
-   applying_an_execution_plan
-   deleting_an_execution_plan
-   obtaining_execution_plan_metadata

api-ref/source/resource_formation_service/index.rst

@@ -1,76 +0,0 @@
-:original_name: rfs_02_0000.html
-
-.. _rfs_02_0000:
-
-Resource Formation Service
-==========================
-
-Status Code
------------
-
-After sending a request, you will receive a response, including a status code, response header, and response body.
-
-A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For more information, see :ref:`Status Code <aos_02_0041>`.
-
-For example, if status code **201** is returned for calling the API used to obtain a user token, the request is successful.
-
-Response Header
----------------
-
-Similar to a request, a response also has a header, for example, **Content-Type**.
-
-:ref:`Figure 1 <rfs_02_0000__en-us_topic_0000001515721149_en-us_topic_0170155703_fig4865141011511>` shows the response header fields for the API used to obtain a user token. The **x-subject-token** header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
-
-.. _rfs_02_0000__en-us_topic_0000001515721149_en-us_topic_0170155703_fig4865141011511:
-
-.. figure:: /_static/images/en-us_image_0000001893402017.png
-   :alt: **Figure 1** Header fields of the response to the request for obtaining a user token
-
-   **Figure 1** Header fields of the response to the request for obtaining a user token
-
-(Optional) Response Body
-------------------------
-
-The body of a response is often returned in structured format as specified in the **Content-Type** header field. The response body transfers content except the response header.
-
-The following is part of the response body for the API used to obtain a user token.
-
-::
-
-   {
-       "token": {
-           "expires_at": "2019-02-13T06:52:13.855000Z",
-           "methods": [
-               "password"
-           ],
-           "catalog": [
-               {
-                   "endpoints": [
-                       {
-                           "region_id": "az-01",
-   ......
-
-If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
-
-::
-
-   {
-       "error_msg": "The format of message is error",
-       "error_code": "AS.0001"
-   }
-
-In the response body, **error_code** is an error code, and **error_msg** provides information about the error.
-
--  :ref:`Stacks <topic_300000000>`
--  :ref:`Execution Plans <topic_300000001>`
--  :ref:`Template Analysis <topic_300000002>`
--  :ref:`Template Management <topic_300000003>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   stacks/index
-   execution_plans/index
-   template_analysis/index
-   template_management/index

api-ref/source/resource_formation_service/stacks/index.rst

@@ -1,38 +0,0 @@
-:original_name: topic_300000000.html
-
-.. _topic_300000000:
-
-Stacks
-======
-
--  :ref:`Listing Events of a Stack <liststackevents>`
--  :ref:`Obtaining Stack Metadata <getstackmetadata>`
--  :ref:`Listing Stacks <liststacks>`
--  :ref:`Creating a Stack <createstack>`
--  :ref:`Obtaining a Stack Template <getstacktemplate>`
--  :ref:`Listing Stack Resources <liststackresources>`
--  :ref:`Listing Stack Outputs <liststackoutputs>`
--  :ref:`Continuing to Deploy a Stack <continuedeploystack>`
--  :ref:`Deploying a Stack <deploystack>`
--  :ref:`Deleting a Stack <deletestack>`
--  :ref:`Updating a Stack <updatestack>`
--  :ref:`Deleting a Stack with Conditions <deletestackenhanced>`
--  :ref:`Continuing to Roll Back a Stack <continuerollbackstack>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   listing_events_of_a_stack
-   obtaining_stack_metadata
-   listing_stacks
-   creating_a_stack
-   obtaining_a_stack_template
-   listing_stack_resources
-   listing_stack_outputs
-   continuing_to_deploy_a_stack
-   deploying_a_stack
-   deleting_a_stack
-   updating_a_stack
-   deleting_a_stack_with_conditions
-   continuing_to_roll_back_a_stack

api-ref/source/resource_formation_service/template_analysis/index.rst

@@ -1,14 +0,0 @@
-:original_name: topic_300000002.html
-
-.. _topic_300000002:
-
-Template Analysis
-=================
-
--  :ref:`Parsing Template Variables <parsetemplatevariables>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   parsing_template_variables

api-ref/source/resource_formation_service/template_management/index.rst

@@ -1,28 +0,0 @@
-:original_name: topic_300000003.html
-
-.. _topic_300000003:
-
-Template Management
-===================
-
--  :ref:`Listing Templates <listtemplates>`
--  :ref:`Deleting a Template <deletetemplate>`
--  :ref:`Updating Template Metadata <updatetemplatemetadata>`
--  :ref:`Obtaining Template Metadata <showtemplatemetadata>`
--  :ref:`Listing Template Versions <listtemplateversions>`
--  :ref:`Deleting a Template Version <deletetemplateversion>`
--  :ref:`Obtaining Template Version Content <showtemplateversioncontent>`
--  :ref:`Obtaining Template Version Metadata <showtemplateversionmetadata>`
-
-.. toctree::
-   :maxdepth: 1
-   :hidden: 
-
-   listing_templates
-   deleting_a_template
-   updating_template_metadata
-   obtaining_template_metadata
-   listing_template_versions
-   deleting_a_template_version
-   obtaining_template_version_content
-   obtaining_template_version_metadata

doc/source/index.rst

@@ -1,9 +1,11 @@
 Resource Formation Service
 ==========================
 
+With Resource Formation Service, you can manage system and service resources (all physical or logical entities that can be located and described, such as databases, VPCs, pipelines, and IAM roles). You can automatically deploy specified cloud service resources based on the template which uses the HCL (an open ecosystem) syntax.
+
 .. directive_wrapper::
    :class: container-sbv
 
    .. service_card::
       :service_type: rfs
-      :environment: internal
+      :umn: This document describes basic concepts, functions, key terms, and FAQs of the Resource Formation Service (RFS) and provides guidances for creating private templates, stacks, execution plans and so on.

tox.ini

@@ -44,27 +44,6 @@ commands =
   {[testenv:umn]commands}
   {[testenv:json-umn]commands}
 
-[testenv:docs-pdf]
-deps =
-  {[testenv:docs]deps}
-  {[testenv:bindeps]deps}
-allowlist_externals =
-  rm
-  mkdir
-  wget
-  make
-  bash
-  cp
-commands =
-  mkdir -p doc/build/pdf
-  {[testenv:bindeps]commands}
-  mkdir -p {toxinidir}/_templates
-  wget -O {toxinidir}/_templates/longtable.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/longtable.tex.jinja
-  wget -O {toxinidir}/_templates/tabular.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabular.tex.jinja
-  wget -O {toxinidir}/_templates/tabulary.tex.jinja https://gitea.eco.tsi-dev.otc-service.com/infra/docs-templates/raw/branch/main/templates/tabulary.tex.jinja
-  {[testenv:api-ref-pdf-docs]commands}
-  {[testenv:umn-pdf-docs]commands}
-
 
 # HTML version
 [testenv:api-ref]
@@ -106,12 +85,12 @@ commands =
   rm -rf api-ref/build/pdf
   cp -r {toxinidir}/_templates api-ref/source/_templates/
   sphinx-build -W --keep-going -b latex api-ref/source api-ref/build/pdf/
-  bash -c "for f in api-ref/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
+  bash -c "for f in api-ref/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
   bash -c "for f in api-ref/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C api-ref/build/pdf
+  make -C api-ref/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
   mkdir -p doc/build/pdf
   cp api-ref/build/pdf/rfs-api-ref.pdf doc/build/pdf/
-
+  cp api-ref/build/pdf/rfs-api-ref.pdf doc/build/html/
 
 # HTML version
 [testenv:umn]
@@ -153,12 +132,12 @@ commands =
   rm -rf umn/build/pdf
   cp -r {toxinidir}/_templates umn/source/_templates/
   sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/
-  bash -c "for f in umn/build/pdf/*.gif; do convert $f $\{f/%gif/png\}; done || true"
+  bash -c "for f in umn/build/pdf/*.gif; do convert $f[0] $\{f/%gif/png\}; done || true"
   bash -c "for f in umn/build/pdf/*.tex; do sed -iorig 's/\.gif//g' $f; done"
-  make -C umn/build/pdf
+  make -C umn/build/pdf LATEXMKOPTS="-interaction=nonstopmode"
   mkdir -p doc/build/pdf
   cp umn/build/pdf/rfs-umn.pdf doc/build/pdf/
-
+  cp umn/build/pdf/rfs-umn.pdf doc/build/html/
 
 
 [testenv:bindeps]