Fix changelog URL pattern to "{repo}/changes/"

[noissue]

Author: pedro-psb

src/pulp_docs/mkdocs_macros.py

@@ -179,26 +179,26 @@ def _place_doc_files(src_dir: Path, docs_dir: Path, repo: Repo, api_src_dir: Pat
 
     # Get changelog
     repo.status.has_changelog = False
-    changes_dir = Path(docs_dir / "changes")
+    changes_dir = Path(docs_dir)
     changes_dir.mkdir(exist_ok=True)
     for changelog_name in ("CHANGELOG.md", "CHANGES.md", "CHANGES.rst"):
         changelog_path = Path(src_dir / changelog_name)
         if changelog_path.exists():
-            shutil.copy(changelog_path, changes_dir / "changelog.md")
+            shutil.copy(changelog_path, changes_dir / "changes.md")
             repo.status.has_changelog = True
             return
 
     # Create redirect message for nested packages
     if isinstance(repo, SubPackage):
-        empty_changelog = changes_dir / "changelog.md"
-        changes_url = f"site:{repo.subpackage_of}/changes/changelog/"
+        empty_changelog = changes_dir / "changes.md"
+        changes_url = f"site:{repo.subpackage_of}/changes/"
         empty_changelog.write_text(
             f"# Changelog\n\nThe changelog for this package is nested under [{repo.subpackage_of}]({changes_url})."
         )
         return
 
     # Create placeholder, case it was not possible to fetch one
-    empty_changelog = changes_dir / "changelog.md"
+    empty_changelog = changes_dir / "changes.md"
     empty_changelog.write_text(
         "# Changelog\n\nThe repository does not provide a changelog or there was a problem fetching it."
     )
@@ -360,7 +360,7 @@ def get_repos(repo_type="content"):
                 "version": "3.12.1",
                 "rest_api_url": f"https://docs.pulpproject.org/{repo.name}/restapi.html",
                 "codebase_url": f"https://github.com/{repo.owner}/{repo.name}",
-                "changelog_url": f"site:{repo.name}/changes/changelog/",
+                "changelog_url": f"site:{repo.name}/changes/",
             }
             for repo in repos_list
         ]

src/pulp_docs/navigation.py

@@ -132,17 +132,15 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
         {"More": f.get_children("pulp-docs/docs/sections/help/more")},
         {
             "Changelogs": [
-                {"Pulpcore": "pulpcore/changes/changelog.md"},
+                {"Pulpcore": "pulpcore/changes.md"},
                 {
                     "Plugins": sorted(
-                        f.repo_grouping(
-                            "{repo}/changes", repo_types=["content"]
-                        ).items()
+                        f.aggregate_file("{repo}/changes.md", repo_types=["content"] ).items()
                     )
                 },
                 {
                     "Extra": sorted(
-                        f.repo_grouping("{repo}/changes", repo_types=["other"]).items()
+                        f.aggregate_file("{repo}/changes.md", repo_types=["other"]).items()
                     )
                 },
             ]

src/pulp_docs/utils/aggregation.py

@@ -137,12 +137,27 @@ def repo_grouping(
                     if _repo_content:
                         content_type_name = Names.get(content_type)
                         repo_nav[content_type_name] = _repo_content  # type: ignore
+
+                # Add REST API and Changes
                 if repo.type == "content" and "docs/user" in template_str:
                     repo_nav["Rest API"] = f"{repo.name}/docs/rest_api.md"
+
                 if repo_nav:
                     _nav[repo.title] = repo_nav
         return _nav or ["#"]
 
+    def aggregate_file(self, template_str: str, repo_types: t.Optional[t.List[str]]=None):
+        """Aggregate single file by RepoType then Repo"""
+        selected_repos = self.repos.all
+        if repo_types:
+            selected_repos = self.repos.get_repos(repo_types=repo_types)
+
+        _nav = {}
+        for repo in selected_repos:
+            _nav[repo.title] = template_str.format(repo=repo.name)
+
+        return _nav
+
     def _parse_template_str(
         self, template_str: str, repo_name: str, content_type: t.Optional[str] = None
     ) -> Path: