Partial implementation

Author: pedro-psb

src/pulp_docs/mkdocs_macros.py

@@ -253,7 +253,21 @@ def define_env(env):
     @env.macro
     def get_repos(repo_type="content"):
         "Return repo names by type"
-        return sorted(repos.get_repos(repo_types=[repo_type]), key=lambda x: x.title)
+        _repo_type = [repo_type] if repo_type else None
+        repos_list = sorted(
+            repos.get_repos(repo_types=_repo_type), key=lambda x: x.title
+        )
+        repos_data = [
+            {
+                "title": repo.title,
+                "version": "3.12.1",
+                "rest_api": f"https://docs.pulpproject.org/{repo.name}/restapi.html",
+                "codebase_url": f"https://github.com/{repo.owner}/{repo.name}",
+                "changelog_url": f"site:pulp-docs/docs/sections/help/changelogs/{repo.name}.md",
+            }
+            for repo in repos_list
+        ]
+        return repos_data
 
 
 def on_pre_page_macros(env):

src/pulp_docs/navigation.py

@@ -56,16 +56,8 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
                     {content-type}
     """
     f = AgregationUtils(tmpdir, repos)
-    help_section = [
-        {"Overview": f.section_file("help/index.md")},
-        {
-            "Bugs, Feature and Backport Requests": f.section_file(
-                "help/bugs-features.md"
-            )
-        },
-    ]
     usage_section = [
-        {"Overview": f.section_file("usage/index.md")},
+        {"Overview": f.section_file("user/index.md")},
         {
             "Pulpcore": [
                 f.section(
@@ -113,7 +105,7 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
         ),
     ]
     development_section = [
-        {"Overview": f.section_file("development/index.md")},
+        {"Overview": f.section_file("dev/index.md")},
         {
             "Pulpcore": [
                 f.section(
@@ -132,22 +124,18 @@ def grouped_by_persona(tmpdir: Path, repos: Repos):
         },
         {"Extras": f.repo_grouping("{repo}/docs/dev/{content}", repo_types=["other"])},
     ]
-    reference_section = [
-        {"Overview": f.section_file("reference/index.md")},
-        {"Rest API": "pulp-docs/docs/rest_api.md"},
-        {"Glossary": f.section_file("reference/02-glossary.md")},
-        {"Pulpcore": f.section(Names.CORE, f.get_children, "pulpcore/docs/reference")},
-        {"Plugins": f.repo_grouping("{repo}/docs/reference", repo_types=["content"])},
-        {"Extra": f.repo_grouping("{repo}/docs/reference", repo_types=["other"])},
+    help_section = [
+        {"Overview": f.section_file("help/index.md")},
+        {"How to use this documentation": f.section_file("help/bugs-features.md")},
+        {"Changelog": f.repo_grouping("{repo}/CHANGES.md")},
     ]
 
     # Main Section
     navigation = [
         {"Home": "index.md"},
         {"User Manual": usage_section},
         {"Admin Manual": admin_section},
-        {"Development": development_section},
-        {"Reference": reference_section},
+        {"Developer Manual": development_section},
         {"Help": help_section},
     ]
     return navigation

src/pulp_docs/repository.py

@@ -203,6 +203,10 @@ class SubPackage:
     local_basepath = None
     branch_in_use = ""
     branch = ""
+    owner = ""
+
+    def __post_init__(self):
+        self.owner = self.subpackage_of
 
 
 @dataclass

src/pulp_docs/utils/aggregation.py

@@ -178,7 +178,7 @@ def repo_reference_grouping(self):
 
     def section_file(self, section_and_filename: str):
         """Get a markdown file from the website section folder."""
-        basepath = "pulpcore/docs/sections"
+        basepath = "pulp-docs/docs/sections"
         return f"{basepath}/{section_and_filename}"
 
     def section_children(self, section_name: str):

staging_docs/sections/admin/index.md

@@ -0,0 +1 @@
+# Overview

staging_docs/sections/dev/index.md

@@ -0,0 +1 @@
+# Overview

staging_docs/sections/help/index.md

@@ -0,0 +1 @@
+# Overview

staging_docs/sections/reference/index.md

@@ -0,0 +1 @@
+# Overview

staging_docs/sections/user/index.md

@@ -0,0 +1,60 @@
+---
+hide:
+  - toc
+---
+<div class="hero-header" markdown>
+# Overview
+
+## This section is for users who need to need create sync, publish and interact with repositories.
+
+
+
+<div class="grid cards" markdown>
+
+-   **Get Started**
+
+    ---
+    
+    Complete the started tutorial [here](#).
+
+    
+-   **Understand the docs**
+    
+    ---
+
+    Get familiar withhow to use this documentation works. [here](#)
+
+- **Explore**
+
+    ---
+
+    Some content
+
+- **Engage**
+
+    ---
+
+    Some content
+
+</div>
+</div>
+
+---
+
+## Quick Links
+
+
+{% for repo_type in ("core", "content") %}
+Repo | Version | Rest API | Github Page | Changelog
+--- | --- | --- | --- | --- 
+{% for repo in get_repos(repo_type) -%}
+{{ repo.title }} | `{{ repo.version }}` | <a href="{{ repo.rest_api_url}}" target="_blank">:link:</a> | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
+{% endfor %}
+{% endfor %}
+
+Repo | Version | Code (Github) | Changelog
+--- | --- | --- | --- 
+{% for repo in get_repos("other") -%}
+{{ repo.title }} | `{{ repo.version }}` | [:link:]({{ repo.codebase_url }}) | [:link:]({{ repo.changelog_url }})
+{% endfor %}
+