Fix modules

cloudposse · Nov 11, 2024 · b127c8d · b127c8d
1 parent 4190b62
commit b127c8d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 10 deletions.
diff --git a/scripts/docs-collator/ComponentRendererMD.py b/scripts/docs-collator/ComponentRendererMD.py
@@ -31,23 +31,19 @@ def render(self, docs_dir):
         module_docs_dir = os.path.join(*path_components)
         logging.info(f"Module docs dir: {module_docs_dir}")
 
-        # self._pre_rendering_fixes(self.component, module_download_dir)
         self.__render_doc()
         content = io.read_file_to_string(os.path.join(module_download_dir, README_MD))
-        # content = (
-        #     rendering.replace_relative_links_with_github_links(
-        #         repo, submodule_readme_content, rel_dir
-        #     )
-        # )
-        rel_dir = "Test"
+
+        rel_dir = os.path.relpath(self.component.terraform_dir, self.component.repo.dir)
+
         jenv = templating.init_templating(self.templates_dir)
         self.doc_template = jenv.get_template("readme.md")
 
         content = self.doc_template.render(
             label=self.component.name,
             title=self.component.name,
             description=self.component.name,
-            github_edit_url=f"https://github.com/{self.component.repo.full_name}/blob/{self.component.repo.default_branch}/{rel_dir}",
+            github_edit_url=f"https://github.com/{self.component.repo.full_name}/blob/{self.component.repo.default_branch}/{rel_dir}/README.md",
             content=content,
         )
 

diff --git a/scripts/docs-collator/templates/components/single/readme.md b/scripts/docs-collator/templates/components/single/readme.md
@@ -4,8 +4,8 @@
 {{- $fullModuleName := (ds "config").name -}}
 {{- $shortModuleName := ( conv.Default $fullModuleName (conv.Join (coll.GoSlice ($fullModuleName | strings.SplitN "-" 3) 1) "-")) -}}
 ---
-title: {{ $shortModuleName }}
-sidebar_label: {{ $shortModuleName }}
+title: {{ $fullModuleName }}
+sidebar_label: {{ $fullModuleName }}
 sidebar_class_name: command
 {{- if has (ds "config") "description" }}
 description: |-