Compare commits

...

12 Commits

Author SHA1 Message Date
c9e2e7cbde modifying index.rst file 2025-02-17 10:11:47 +01:00
5a4e7acb60 merge upstream 2025-02-17 09:07:37 +00:00
75eb9a46df revert 9b2ba5c4f87a101c8231accb5130166aeebb1dfc
revert Modified index.rst file
2025-02-17 09:07:29 +00:00
9b2ba5c4f8 Modified index.rst file 2025-02-17 09:56:36 +01:00
401960665e Modifying index.rst file
Reviewed-by: Rumpler, Mihály <mihaly.rumpler@t-systems.com>
Co-authored-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
Co-committed-by: Natalia Bobkova <natalia.bobkova@t-systems.com>
2025-02-14 14:22:33 +00:00
485f75d4f0 Modifying index.rst file 2025-02-14 14:55:58 +01:00
ce4f9384cd Changes to rfs_umn from docs/doc-exports#1261 (WIP Upload RFS UMN
Upload rfs u

Reviewed-by: Rumpler, Mihály <mihaly.rumpler@t-systems.com>
Co-authored-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>
Co-committed-by: OpenTelekomCloud Proposal Bot <proposalbot@otc-service.com>
2025-02-13 11:07:27 +00:00
5a3bd97f78 Update tox.ini && conf.py file
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2025-02-10 09:15:09 +00:00
884d958429 disabling pdf temporarily
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2024-12-20 07:02:22 +00:00
4b49e936ac Update tox.ini && conf.py file
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2024-12-16 12:45:23 +00:00
7a381633a4 Update tox.ini && conf.py file
Reviewed-by: tischrei <tino.schreiber@t-systems.com>
Co-authored-by: Sebastian Gode <sebastian.gode@telekom.de>
Co-committed-by: Sebastian Gode <sebastian.gode@telekom.de>
2024-11-15 09:47:30 +00:00
0e4ca7fd50 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-16 11:41:25 +00:00
173 changed files with 2463 additions and 32 deletions

View File

@ -106,6 +106,7 @@ html_title = "Resource Formation Service - API Reference"
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
templates_path = ['_templates']
# Do not include sources into the rendered results # Do not include sources into the rendered results
html_copy_source = False html_copy_source = False
@ -114,7 +115,7 @@ html_copy_source = False
latex_documents = [ latex_documents = [
('index', ('index',
'rfs-api-ref.tex', 'rfs-api-ref.tex',
u'Resource Formation Service - API Reference', u'Resource Formation Service - API Reference',
u'OpenTelekomCloud', 'manual'), u'OpenTelekomCloud', 'manual'),
] ]
@ -122,4 +123,17 @@ latex_documents = [
repo = Repo(search_parent_directories=True) repo = Repo(search_parent_directories=True)
commit = repo.head.commit commit = repo.head.commit
current_commit_hash = commit.hexsha current_commit_hash = commit.hexsha
current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M') current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
latex_elements = {
'papersize': 'a4paper',
'pointsize': '12pt',
'figure_align': 'H',
'preamble': rf'''
\newcommand{{\githash}}{{{current_commit_hash}}}
\newcommand{{\gitcommittime}}{{{current_commit_time}}}
\newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
\newcommand{{\servicetitle}}{{{otcdocs_service_title}}}
''',
'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
}

View File

@ -107,6 +107,7 @@ html_title = "Resource Formation Service - Service Based View"
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
templates_path = ['_templates']
# Do not include sources into the rendered results # Do not include sources into the rendered results
html_copy_source = False html_copy_source = False
@ -118,4 +119,17 @@ latex_documents = []
repo = Repo(search_parent_directories=True) repo = Repo(search_parent_directories=True)
commit = repo.head.commit commit = repo.head.commit
current_commit_hash = commit.hexsha current_commit_hash = commit.hexsha
current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M') current_commit_time = commit.committed_datetime.strftime('%Y-%m-%d %H:%M')
latex_elements = {
'papersize': 'a4paper',
'pointsize': '12pt',
'figure_align': 'H',
'preamble': rf'''
\newcommand{{\githash}}{{{current_commit_hash}}}
\newcommand{{\gitcommittime}}{{{current_commit_time}}}
\newcommand{{\doctitle}}{{{otcdocs_doc_title}}}
\newcommand{{\servicetitle}}{{{otcdocs_service_title}}}
''',
'sphinxsetup': 'hmargin={15mm,15mm}, vmargin={20mm,30mm}, marginpar=10mm'
}

View File

@ -1,9 +1,11 @@
Resource Formation Service 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:: .. directive_wrapper::
:class: container-sbv :class: container-sbv
.. service_card:: .. service_card::
:service_type: rfs :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.

31
tox.ini
View File

@ -44,23 +44,6 @@ commands =
{[testenv:umn]commands} {[testenv:umn]commands}
{[testenv:json-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}
{[testenv:api-ref-pdf-docs]commands}
{[testenv:umn-pdf-docs]commands}
# HTML version # HTML version
[testenv:api-ref] [testenv:api-ref]
@ -100,13 +83,14 @@ allowlist_externals =
cp cp
commands = commands =
rm -rf api-ref/build/pdf 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/ 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" 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 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/pdf/
cp api-ref/build/pdf/rfs-api-ref.pdf doc/build/html/
# HTML version # HTML version
[testenv:umn] [testenv:umn]
@ -146,13 +130,14 @@ allowlist_externals =
cp cp
commands = commands =
rm -rf umn/build/pdf rm -rf umn/build/pdf
cp -r {toxinidir}/_templates umn/source/_templates/
sphinx-build -W --keep-going -b latex umn/source umn/build/pdf/ 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" 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 mkdir -p doc/build/pdf
cp umn/build/pdf/rfs-umn.pdf 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] [testenv:bindeps]

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 182 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 299 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 212 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 252 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 84 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 246 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 142 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 299 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 106 KiB

Some files were not shown because too many files have changed in this diff Show More