From 22594ecced0a120cf22542ea5dcdcc32b1bd37cc Mon Sep 17 00:00:00 2001 From: SebastianGode Date: Wed, 24 May 2023 11:17:43 +0200 Subject: [PATCH 1/4] Added search index params on confpy --- otc_metadata/templates/conf.py.j2 | 9 +++++++++ tools/generate_doc_confpy.py | 15 ++++++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/otc_metadata/templates/conf.py.j2 b/otc_metadata/templates/conf.py.j2 index 3228eec8..ac1fc39d 100644 --- a/otc_metadata/templates/conf.py.j2 +++ b/otc_metadata/templates/conf.py.j2 @@ -37,6 +37,15 @@ otcdocs_git_fqdn = '{{ git_fqdn }}' otcdocs_git_type = '{{ git_type }}' {%- endif %} +# Those variables are needed for indexing into OpenSearch +otcdocs_doc_environment = '{{ doc_environment }}' +otcdocs_doc_link = '{{ doc_link }}' +otcdocs_doc_title = '{{ doc_title }}' +otcdocs_doc_type = '{{ doc_type }}' +otcdocs_service_title = '{{ service_title }}' +otcdocs_service_type = '{{ service_type }}' +otcdocs_service_category = '{{ service_category }}' + # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index 728e8686..b526930e 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -150,6 +150,14 @@ def process_repositories(args, service): site_name="Internal Documentation Portal", logo_url="https://docs-int.otc-service.com", ) + context["doc_environment"] = args.target_environment + context["doc_link"] = doc['link'] + context["doc_title"] = doc['title'] + context["doc_type"] = doc['type'] + context["service_title"] = service['service_title'] + context["service_type"] = service['service_type'] + context["service_category"] = service['service_category'] + conf_py_content = conf_py_template.render(**context) with open(conf_py_path, "w", encoding="utf-8", newline="") as out: logging.debug(f"Generating {conf_py_path} from template...") @@ -251,7 +259,7 @@ def process_repositories(args, service): if args.branch_force: push_args.append("--force") repo_to.git.push(*push_args) - if "github" in url_to: + if "github" in url_to and args.open_gh_pr: subprocess.run( args=["gh", "pr", "create", "-f"], cwd=copy_to, check=False ) @@ -337,6 +345,11 @@ def main(): ), help="Commit description for the commit", ) + parser.add_argument( + "--open-gh-pr", + action="store_true", + help="Whether to open a PR on GitHub" + ) args = parser.parse_args() logging.basicConfig(level=logging.DEBUG) -- 2.34.1 From 9a3ea9501829d4fc9ab353703d3ea863bf0bab8f Mon Sep 17 00:00:00 2001 From: SebastianGode Date: Wed, 24 May 2023 13:15:04 +0200 Subject: [PATCH 2/4] Removed gh pr argument --- tools/generate_doc_confpy.py | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index b526930e..ec0b87a1 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -259,7 +259,7 @@ def process_repositories(args, service): if args.branch_force: push_args.append("--force") repo_to.git.push(*push_args) - if "github" in url_to and args.open_gh_pr: + if "github" in url_to: subprocess.run( args=["gh", "pr", "create", "-f"], cwd=copy_to, check=False ) @@ -345,11 +345,6 @@ def main(): ), help="Commit description for the commit", ) - parser.add_argument( - "--open-gh-pr", - action="store_true", - help="Whether to open a PR on GitHub" - ) args = parser.parse_args() logging.basicConfig(level=logging.DEBUG) -- 2.34.1 From 6d5be1ad298cbd375b32b184cf72b5e555dbf238 Mon Sep 17 00:00:00 2001 From: SebastianGode Date: Tue, 30 May 2023 09:59:10 +0200 Subject: [PATCH 3/4] Sorting --- otc_metadata/templates/conf.py.j2 | 2 +- tools/generate_doc_confpy.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/otc_metadata/templates/conf.py.j2 b/otc_metadata/templates/conf.py.j2 index ac1fc39d..b18b66a4 100644 --- a/otc_metadata/templates/conf.py.j2 +++ b/otc_metadata/templates/conf.py.j2 @@ -42,9 +42,9 @@ otcdocs_doc_environment = '{{ doc_environment }}' otcdocs_doc_link = '{{ doc_link }}' otcdocs_doc_title = '{{ doc_title }}' otcdocs_doc_type = '{{ doc_type }}' +otcdocs_service_category = '{{ service_category }}' otcdocs_service_title = '{{ service_title }}' otcdocs_service_type = '{{ service_type }}' -otcdocs_service_category = '{{ service_category }}' # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index ec0b87a1..c7019c35 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -154,9 +154,9 @@ def process_repositories(args, service): context["doc_link"] = doc['link'] context["doc_title"] = doc['title'] context["doc_type"] = doc['type'] + context["service_category"] = service['service_category'] context["service_title"] = service['service_title'] context["service_type"] = service['service_type'] - context["service_category"] = service['service_category'] conf_py_content = conf_py_template.render(**context) with open(conf_py_path, "w", encoding="utf-8", newline="") as out: -- 2.34.1 From 6994dd37f79db0f2d13d1325ec3542deb7cdf6a4 Mon Sep 17 00:00:00 2001 From: tischrei Date: Tue, 30 May 2023 08:48:46 +0000 Subject: [PATCH 4/4] add small change --- tools/generate_doc_confpy.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/tools/generate_doc_confpy.py b/tools/generate_doc_confpy.py index c7019c35..4f5e1ce0 100644 --- a/tools/generate_doc_confpy.py +++ b/tools/generate_doc_confpy.py @@ -151,7 +151,16 @@ def process_repositories(args, service): logo_url="https://docs-int.otc-service.com", ) context["doc_environment"] = args.target_environment - context["doc_link"] = doc['link'] + if doc['link']: + context["doc_link"] = doc['link'] + else: + context["doc_link"] = ( + '/' + + service['service_uri'] + + '/' + + doc['type'] + + '/' + ) context["doc_title"] = doc['title'] context["doc_type"] = doc['type'] context["service_category"] = service['service_category'] -- 2.34.1