Compare commits

..

23 Commits

Author SHA1 Message Date
be56be7b24 Added setuptools as requirement
All checks were successful
gl/check check status: success (be56be7b248968baa78e80c96e8634c1dfbdf401)
gl/gate gate status: success (be56be7b248968baa78e80c96e8634c1dfbdf401)
2024-01-03 10:54:43 +00:00
bff9eff2bd Differentiate between public and internal otcdocstheme
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>
2023-11-15 14:07:16 +00:00
d5e7269ae9 Change category name Database to Databases
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-11-15 13:49:01 +00:00
1541a02210 Added sphinx-minify to tox
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>
2023-11-15 13:48:58 +00:00
96ffbc1403 correct swiss portal name
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-09-06 12:35:10 +00:00
ca8c5fb34c change the base_url accordingly
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-09-06 07:42:07 +00:00
a6a001cdba Changed Search Index
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>
2023-08-29 07:25:42 +00:00
7b319ca858 revert 9bb3ef92a5
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-08-21 12:56:38 +00:00
9bb3ef92a5 Change logo_url for Swiss Cloud
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-08-21 12:38:32 +00:00
898c1aafc2 fixing tool generate doc confpy to read additional metadata
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-16 23:04:21 +00:00
d8ed8a0ba4 fixing various different issues
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-16 16:06:46 +00:00
bc0676ac51 adding constraints reference
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-09 12:05:33 +00:00
6caf290136 adding sort function before the data are generated to yaml
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-07 11:23:26 +00:00
c7c190f0a3 adding iam permissions metadata and sd metadata
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-08-07 06:34:27 +00:00
c3374e47b4 adding sorting by category
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-06-13 14:05:13 +00:00
de5b323b97 Update 'otc_metadata/templates/conf.py.j2'
Reviewed-by: Gode, Sebastian <sebastian.gode@t-systems.com>
Co-authored-by: tischrei <tino.schreiber@t-systems.com>
Co-committed-by: tischrei <tino.schreiber@t-systems.com>
2023-06-13 11:50:11 +00:00
9241395bec removing big data service category as obsolete
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>
2023-06-12 07:43:42 +00:00
47b3314fdc gitcontrol fix for repositories
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-06-08 18:32:41 +00:00
cc6fcb3149 removing public images documentation entry as such document is currently not supported
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-06-07 18:10:30 +00:00
6e80bc7c35 removing not suported documents from Swisscloud
Reviewed-by: vladimirhasko <vladimirhasko@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-06-07 17:33:07 +00:00
7098c65dd8 removing service entries from services.yaml as obsolete due to split and distributing all service and document entries to separate files
Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-committed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
2023-06-07 14:50:08 +00:00
bac06c250f feat: split metadata into smal pieces
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2023-06-02 07:20:02 +00:00
177ba3a3fa fix repo locations
Co-authored-by: gtema <artem.goncharov@gmail.com>
Co-committed-by: gtema <artem.goncharov@gmail.com>
2023-06-01 10:15:30 +00:00
108 changed files with 1241 additions and 997 deletions

View File

@ -9,13 +9,13 @@
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
__all__ = ['__version__', 'Docs']
__all__ = ["__version__", "Docs"]
import pbr.version
from otc_metadata.services import Services # flake8: noqa
__version__ = pbr.version.VersionInfo('otc-metadata').version_string()
__version__ = pbr.version.VersionInfo("otc-metadata").version_string()
_service_manager = None

View File

@ -12,30 +12,45 @@
# limitations under the License.
import os
import pathlib
import yaml
__all__ = ['read_data']
__all__ = ["read_data"]
DATA_DIR = os.path.dirname(__file__)
def read_data(filename):
"""Return data that is shipped inside the Python package.
"""
"""Return data that is shipped inside the Python package."""
filepath = os.path.join(DATA_DIR, filename)
with open(filepath, 'r') as fd:
return yaml.safe_load(fd)
with open(filepath, "r") as fd:
data = yaml.safe_load(fd)
# Merge data found in individual element files
data.setdefault("documents", list())
data.setdefault("services", list())
data.setdefault("service_categories", list())
for item in pathlib.Path(DATA_DIR, "documents").glob("*.yaml"):
with open(item, "r") as fp:
data["documents"].append(yaml.safe_load(fp))
for item in pathlib.Path(DATA_DIR, "services").glob("*.yaml"):
with open(item, "r") as fp:
data["services"].append(yaml.safe_load(fp))
for item in pathlib.Path(DATA_DIR, "service_categories").glob(
"*.yaml"
):
with open(item, "r") as fp:
data["service_categories"].append(yaml.safe_load(fp))
return data
def rewrite_data(filename, data):
"""Rewrites data formatting it
"""
"""Rewrites data formatting it"""
from ruamel.yaml import YAML
_yaml = YAML()
_yaml.indent(mapping=2, sequence=4, offset=2)
filepath = os.path.join(DATA_DIR, filename)
with open(filepath, 'w') as fd:
with open(filepath, "w") as fd:
_yaml.dump(data, fd)

View File

@ -0,0 +1,9 @@
---
hc_location: api/aom
html_location: docs/aom/api-ref
link: /application-operations-management/api-ref/
pdf_name: aom-api-ref
rst_location: api-ref/source
service_type: aom
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/aom
html_location: docs/aom/umn
link: /application-operations-management/umn/
pdf_name: aom-umn
rst_location: umn/source
service_type: aom
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/as
html_location: docs/as/api-ref
link: /auto-scaling/api-ref/
pdf_name: as-api-ref
rst_location: api-ref/source
service_type: as
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/as
html_location: docs/as/umn
link: /auto-scaling/umn/
pdf_name: as-umn
rst_location: umn/source
service_type: as
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/cbr
html_location: docs/cbr/api-ref
link: /cloud-backup-recovery/api-ref/
pdf_name: cbr-api-ref
rst_location: api-ref/source
service_type: cbr
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/cbr
html_location: docs/cbr/umn
link: /cloud-backup-recovery/umn/
pdf_name: cbr-umn
rst_location: umn/source
service_type: cbr
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api2/cce
html_location: docs/cce/api-ref
link: /cloud-container-engine/api-ref/
pdf_name: cce-api-ref
rst_location: api-ref/source
service_type: cce
title: API Reference
type: api-ref

View File

@ -0,0 +1,8 @@
---
hc_location: usermanual2/cce
html_location: docs/cce/umn
link: /cloud-container-engine/umn/
rst_location: umn/source
service_type: cce
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/ces
html_location: docs/ces/api-ref
link: /cloud-eye/api-ref/
pdf_name: ces-api-ref
rst_location: api-ref/source
service_type: ces
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/ces
html_location: docs/ces/umn
link: /cloud-eye/umn/
pdf_name: ces-umn
rst_location: umn/source
service_type: ces
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/cts
html_location: docs/cts/api-ref
link: /cloud-trace-service/api-ref/
pdf_name: cts-api-ref
rst_location: api-ref/source
service_type: cts
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/cts
html_location: docs/cts/umn
link: /cloud-trace-service/umn/
pdf_name: cts-umn
rst_location: umn/source
service_type: cts
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/dc
html_location: docs/dc/api-ref
link: /direct-connect/api-ref/
pdf_name: dc-api-ref
rst_location: api-ref/source
service_type: dc
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/dc
html_location: docs/dc/umn
link: /direct-connect/umn/
pdf_name: dc-umn
rst_location: umn/source
service_type: dc
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/deh
html_location: docs/deh/api-ref
link: /dedicated-host/api-ref/
pdf_name: deh-api-ref
rst_location: api-ref/source
service_type: deh
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/deh
html_location: docs/deh/umn
link: /dedicated-host/umn/
pdf_name: deh-umn
rst_location: umn/source
service_type: deh
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/dns
html_location: docs/dns/api-ref
link: /domain-name-service/api-ref/
pdf_name: dns-api-ref
rst_location: api-ref/source
service_type: dns
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/dns
html_location: docs/dns/umn
link: /domain-name-service/umn/
pdf_name: dns-umn
rst_location: umn/source
service_type: dns
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/ecs
html_location: docs/ecs/api-ref
link: /elastic-cloud-server/api-ref/
pdf_name: ecs-api-ref
rst_location: api-ref/source
service_type: ecs
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/ecs
html_location: docs/ecs/umn
link: /elastic-cloud-server/umn/
pdf_name: ecs-umn
rst_location: umn/source
service_type: ecs
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/eip
html_location: docs/eip/api-ref
link: /elastic-ip/api-ref/
pdf_name: eip-api-ref
rst_location: api-ref/source
service_type: eip
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/eip
html_location: docs/eip/umn
link: /elastic-ip/umn/
pdf_name: eip-umn
rst_location: umn/source
service_type: eip
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/elb
html_location: docs/elb/api-ref
link: /elastic-load-balancing/api-ref/
pdf_name: elb-api-ref
rst_location: api-ref/source
service_type: elb
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/elb
html_location: docs/elb/umn
link: /elastic-load-balancing/umn/
pdf_name: elb-umn
rst_location: umn/source
service_type: elb
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/evs
html_location: docs/evs/api-ref
link: /elastic-volume-service/api-ref/
pdf_name: evs-api-ref
rst_location: api-ref/source
service_type: evs
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/evs
html_location: docs/evs/umn
link: /elastic-volume-service/umn/
pdf_name: evs-umn
rst_location: umn/source
service_type: evs
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/iam
html_location: docs/iam/api-ref
link: /identity-access-management/api-ref/
pdf_name: iam-api-ref
rst_location: api-ref/source
service_type: iam
title: API Reference
type: api-ref

View File

@ -0,0 +1,8 @@
---
html_location: docs/iam/permissions
link: /identity-access-management/permissions/
pdf_name: iam-permissions
rst_location: doc/permissions/source
service_type: iam
title: Permissions
type: permissions

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/iam
html_location: docs/iam/umn
link: /identity-access-management/umn/
pdf_name: iam-umn
rst_location: umn/source
service_type: iam
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/ims
html_location: docs/ims/api-ref
link: /image-management-service/api-ref/
pdf_name: ims-api-ref
rst_location: api-ref/source
service_type: ims
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/ims
html_location: docs/ims/umn
link: /image-management-service/umn/
pdf_name: ims-umn
rst_location: umn/source
service_type: ims
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/kms
html_location: docs/kms/api-ref
link: /key-management-service/api-ref/
pdf_name: kms-api-ref
rst_location: api-ref/source
service_type: kms
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/kms
html_location: docs/kms/umn
link: /key-management-service/umn/
pdf_name: kms-umn
rst_location: umn/source
service_type: kms
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/nat
html_location: docs/natgw/api-ref
link: /nat-gateway/api-ref/
pdf_name: natgw-api-ref
rst_location: api-ref/source
service_type: natgw
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/nat
html_location: docs/natgw/umn
link: /nat-gateway/umn/
pdf_name: natgw-umn
rst_location: umn/source
service_type: natgw
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/obs
html_location: docs/obs/api-ref
link: /object-storage-service/api-ref/
pdf_name: obs-api-ref
rst_location: api-ref/source
service_type: obs
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: api_obs/obs
html_location: docs/obs/s3api
link: /object-storage-service/s3api/
pdf_name: obs-s3api
rst_location: doc/s3api/source
service_type: obs
title: S3 API Reference
type: s3api

View File

@ -0,0 +1,9 @@
---
hc_location: browsertg/obs
html_location: docs/obs/tool
link: /object-storage-service/tool-guide/
pdf_name: obs-tool-guide
rst_location: doc/tool/source
service_type: obs
title: Tool Guide (OBS Browser)
type: tool-guide

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/obs
html_location: docs/obs/umn
link: /object-storage-service/umn/
pdf_name: obs-umn
rst_location: umn/source
service_type: obs
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/rds
html_location: docs/rds/api-ref
link: /relational-database-service/api-ref/
pdf_name: rds-api-ref
rst_location: api-ref/source
service_type: rds
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/rds
html_location: docs/rds/umn
link: /relational-database-service/umn/
pdf_name: rds-umn
rst_location: umn/source
service_type: rds
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/sd
html_location: docs/sd/umn
link: /status-dashboard/umn/
pdf_name: sd-umn
rst_location: umn/source
service_type: sd
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/sdrs
html_location: docs/sdrs/api-ref
link: /storage-disaster-recovery-service/api-ref/
pdf_name: sdrs-api-ref
rst_location: api-ref/source
service_type: sdrs
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/sdrs
html_location: docs/sdrs/umn
link: /storage-disaster-recovery-service/umn/
pdf_name: sdrs-umn
rst_location: umn/source
service_type: sdrs
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/smn
html_location: docs/smn/api-ref
link: /simple-message-notification/api-ref/
pdf_name: smn-api-ref
rst_location: api-ref/source
service_type: smn
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/smn
html_location: docs/smn/umn
link: /simple-message-notification/umn/
pdf_name: smn-umn
rst_location: umn/source
service_type: smn
title: User Guide
type: umn

View File

@ -0,0 +1,9 @@
---
hc_location: api/swr
html_location: docs/swr/api-ref
link: /software-repository-container/api-ref/
pdf_name: swr-api-ref
rst_location: api-ref/source
service_type: swr
title: API Reference
type: api-ref

View File

@ -0,0 +1,9 @@
---
hc_location: usermanual/swr
html_location: docs/swr/umn
link: /software-repository-container/umn/
pdf_name: swr-umn
rst_location: umn/source
service_type: swr
title: User Guide
type: umn

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