Merge pull request #25 from pedro-psb/update-some-references

Update links, add brand color and fix title display

README.md

@@ -24,7 +24,7 @@ Also, this should be used for the production build.
 
 Through a `mkdocs-macro-plugin` hook (called in early stages of mkdocs processing), we inject the following steps:
 
-1. Read [`repolist.yml`](https://github.com/pedro-psb/pulp-docs/blob/main/src/pulp_docs/data/repolist.yml) packaged with `pulp-docs` to know which repos/urls to use
+1. Read [`repolist.yml`](https://github.com/pulp/pulp-docs/blob/main/src/pulp_docs/data/repolist.yml) packaged with `pulp-docs` to know which repos/urls to use
 1. Download/Move all source code required to dir under `tempfile.gettempdir()`
     - Uses `../{repo}` if available OR
     - Uses existing cached `{tmpdir}/{repo}` if available OR
@@ -39,7 +39,7 @@ And thats it, the magic is done.
 Recommended way for daily usage:
 
 ```bash
-pipx install git+https://github.com/pedro-psb/pulp-docs --include-deps
+pipx install git+https://github.com/pulp/pulp-docs --include-deps
 pulp-docs serve
 ```
 

src/pulp_docs/data/mkdocs.yml

@@ -6,7 +6,7 @@ repo_name: pulp/pulpcore
 docs_dir: docs
 theme:
   name: material
-  logo: pulp-docs/docs/assets/logo.png
+  logo: pulp-docs/docs/assets/pulp_logo_icon.svg
   favicon: pulp-docs/docs/assets/favicon.ico
   features:
     - content.code.annotate
@@ -25,7 +25,7 @@ theme:
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
-      primary: indigo
+      primary: custom
       accent: black
       toggle:
         icon: material/toggle-switch-off-outline 

src/pulp_docs/data/repolist.yml

@@ -54,8 +54,8 @@ repos:
       title: Pulp OCI Images
       branch: latest
     - name: pulp-docs
-      owner: pedro-psb
-      title: Docs Tool
+      owner: pulp
+      title: Pulp Docs
       branch: main
     - name: pulp-operator
       owner: pulp

src/pulp_docs/mkdocs_macros.py

@@ -111,7 +111,7 @@ def prepare_repositories(TMPDIR: Path, repos: Repos, config: Config):
 
     # Copy core-files (shipped with pulp-docs) to tmpdir
     shutil.copy(
-        repo_sources / repos.core_repo.name / SRC_DOCS_DIRNAME / "index.md",
+        repo_sources / "pulp-docs" / SRC_DOCS_DIRNAME / "index.md",
         repo_docs / "index.md",
     )
 

staging_docs/css/extra.css

@@ -29,7 +29,13 @@
     text-align: center;
     margin-inline: auto;
 }
+.hide-h1 {
+    position: absolute;
+    left: -999px
+}
 
-.landing-page-h1 {
-    display: None;
+:root {
+  --md-primary-fg-color:        #347dbe;
+  --md-primary-fg-color--light: #ECB7B7;
+  --md-primary-fg-color--dark:  #90030C;/
 }

staging_docs/dev/index.md

@@ -13,7 +13,7 @@ It was developed as part of [The new Pulp "Unified Docs"](https://hackmd.io/eE3k
 
 Through a `mkdocs-macro-plugin` hook (called in early stages of mkdocs processing), we inject the following steps:
 
-1. Read [`repolist.yml`](https://github.com/pedro-psb/pulp-docs/blob/main/src/pulp_docs/data/repolist.yml) packaged with `pulp-docs` to know which repos/urls to use
+1. Read [`repolist.yml`](https://github.com/pulp/pulp-docs/blob/main/src/pulp_docs/data/repolist.yml) packaged with `pulp-docs` to know which repos/urls to use
 1. Download and Place all source code required to dir under `tempfile.gettempdir()`
     - Uses `../{repo}` if available OR
     - Uses existing cached `{tmpdir}/{repo}` if available OR
@@ -27,13 +27,13 @@ Recommended way for daily usage:
 === "pipx"
 
     ```bash
-    pipx install git+https://github.com/pedro-psb/pulp-docs --include-deps
+    pipx install git+https://github.com/pulp/pulp-docs --include-deps
     pulp-docs serve
     ```
 
 === "pip"
 
     ```bash
-    pip --user install git+https://github.com/pedro-psb/pulp-docs
+    pip --user install git+https://github.com/pulp/pulp-docs
     pulp-docs serve
     ```

staging_docs/dev/reference/markdown-cheatsheet.md

@@ -23,7 +23,7 @@ There are basic markdown features recommended for use in Pulp.
     ```
 
 - This is enabled by [mkdocs-site-urls](https://github.com/octoprint/mkdocs-site-urls) plugin.
-- This is preferred over *relative* links because of our complex structure. See tradeoffs [here](https://github.com/pedro-psb/pulp-docs/issues/2)
+- This is preferred over *relative* links because of our complex structure. See tradeoffs [here](https://github.com/pulp/pulp-docs/issues/2)
 
 
 ### Codeblocks

staging_docs/index.md

@@ -0,0 +1,53 @@
+---
+hide:
+  - navigation
+  - toc
+  - footer
+---
+
+# Home {.hide-h1}
+<div class="hero-header" markdown>
+
+![Pulp Logo](site:pulpcore/docs/assets/pulp_logo_big.png)
+
+## Pulp is an open source project that makes it easy for developers to fetch, upload, and distribute *Software Packages* on-prem or in the cloud. {: #pulp-project}
+
+</div>
+
+---
+
+<div class="grid cards" markdown>
+
+-   :material-clock-fast:{ .lg .middle } **Starter Tutorial**
+
+    ---
+
+    Learn to manage content with Pulp and get yourself familiar with core concepts and workflows.
+
+    [:octicons-arrow-right-24: Getting started](site:pulpcore/docs/user/tutorials/01-overview/)
+
+-   :octicons-download-16:{ .lg .middle } **Pulp in a Container**
+
+    ---
+
+    Use OCI (Open Container Initiative) images to install Pulp in single or multi-container setups.
+
+    [:octicons-arrow-right-24: Installation Quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart/)
+
+-   :octicons-rocket-16:{ .lg .middle } **Why Pulp?**
+
+    ---
+
+    Learn why important projects rely on Pulp to manage the lifecyle of huge *Software Content* collections.
+
+    [:octicons-arrow-right-24: Features](#)
+
+-   :octicons-people-16:{ .lg .middle } **Get Involved**
+
+    ---
+
+    Join our communication channels and get to know the contributors and users of Pulp's strong ecosystem.
+
+    [:octicons-arrow-right-24: Community](#)
+
+</div>

staging_docs/sections/admin/index.md

@@ -2,8 +2,10 @@
 hide:
   - toc
 ---
+
+# Admin Guide {.hide-h1}
+
 <div class="hero-header" markdown>
-<h1 class="landing-page-h1"></h1>
 
 ## This section is for **admins**
 

staging_docs/sections/dev/index.md

@@ -2,8 +2,10 @@
 hide:
   - toc
 ---
+
+# Developer Guide {.hide-h1}
+
 <div class="hero-header" markdown>
-<h1 class="landing-page-h1"></h1>
 
 ## This section is for Pulp **developers**
 

staging_docs/sections/user/index.md

@@ -2,9 +2,10 @@
 hide:
   - toc
 ---
-<div class="hero-header" markdown>
 
-<h1 class="landing-page-h1"></h1>
+# User Guide {.hide-h1}
+
+<div class="hero-header" markdown>
 
 ## This section is for **users**