Skip to content

Commit e7fadf8

Browse files
ggaineyggainey
authored
Merge pull request #25 from pedro-psb/update-some-references
Update links, add brand color and fix title display
2 parents 103b7ea + 06e974b commit e7fadf8

File tree

12 files changed

+177
-17
lines changed

12 files changed

+177
-17
lines changed

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Also, this should be used for the production build.
2424

2525
Through a `mkdocs-macro-plugin` hook (called in early stages of mkdocs processing), we inject the following steps:
2626

27-
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
27+
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
2828
1. Download/Move all source code required to dir under `tempfile.gettempdir()`
2929
- Uses `../{repo}` if available OR
3030
- Uses existing cached `{tmpdir}/{repo}` if available OR
@@ -39,7 +39,7 @@ And thats it, the magic is done.
3939
Recommended way for daily usage:
4040

4141
```bash
42-
pipx install git+https://github.com/pedro-psb/pulp-docs --include-deps
42+
pipx install git+https://github.com/pulp/pulp-docs --include-deps
4343
pulp-docs serve
4444
```
4545

‎src/pulp_docs/data/mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ repo_name: pulp/pulpcore
66
docs_dir: docs
77
theme:
88
name: material
9-
logo: pulp-docs/docs/assets/logo.png
9+
logo: pulp-docs/docs/assets/pulp_logo_icon.svg
1010
favicon: pulp-docs/docs/assets/favicon.ico
1111
features:
1212
- content.code.annotate
@@ -25,7 +25,7 @@ theme:
2525
palette:
2626
- media: "(prefers-color-scheme: light)"
2727
scheme: default
28-
primary: indigo
28+
primary: custom
2929
accent: black
3030
toggle:
3131
icon: material/toggle-switch-off-outline

‎src/pulp_docs/data/repolist.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ repos:
5454
title: Pulp OCI Images
5555
branch: latest
5656
- name: pulp-docs
57-
owner: pedro-psb
58-
title: Docs Tool
57+
owner: pulp
58+
title: Pulp Docs
5959
branch: main
6060
- name: pulp-operator
6161
owner: pulp

‎src/pulp_docs/mkdocs_macros.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ def prepare_repositories(TMPDIR: Path, repos: Repos, config: Config):
111111

112112
# Copy core-files (shipped with pulp-docs) to tmpdir
113113
shutil.copy(
114-
repo_sources / repos.core_repo.name / SRC_DOCS_DIRNAME / "index.md",
114+
repo_sources / "pulp-docs" / SRC_DOCS_DIRNAME / "index.md",
115115
repo_docs / "index.md",
116116
)
117117

‎staging_docs/assets/pulp_logo_icon.svg

+96
Loading

‎staging_docs/css/extra.css

+8-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,13 @@
2929
text-align: center;
3030
margin-inline: auto;
3131
}
32+
.hide-h1 {
33+
position: absolute;
34+
left: -999px
35+
}
3236

33-
.landing-page-h1 {
34-
display: None;
37+
:root {
38+
--md-primary-fg-color: #347dbe;
39+
--md-primary-fg-color--light: #ECB7B7;
40+
--md-primary-fg-color--dark: #90030C;/
3541
}

‎staging_docs/dev/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It was developed as part of [The new Pulp "Unified Docs"](https://hackmd.io/eE3k
1313

1414
Through a `mkdocs-macro-plugin` hook (called in early stages of mkdocs processing), we inject the following steps:
1515

16-
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
16+
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
1717
1. Download and Place all source code required to dir under `tempfile.gettempdir()`
1818
- Uses `../{repo}` if available OR
1919
- Uses existing cached `{tmpdir}/{repo}` if available OR
@@ -27,13 +27,13 @@ Recommended way for daily usage:
2727
=== "pipx"
2828

2929
```bash
30-
pipx install git+https://github.com/pedro-psb/pulp-docs --include-deps
30+
pipx install git+https://github.com/pulp/pulp-docs --include-deps
3131
pulp-docs serve
3232
```
3333

3434
=== "pip"
3535

3636
```bash
37-
pip --user install git+https://github.com/pedro-psb/pulp-docs
37+
pip --user install git+https://github.com/pulp/pulp-docs
3838
pulp-docs serve
3939
```

‎staging_docs/dev/reference/markdown-cheatsheet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ There are basic markdown features recommended for use in Pulp.
2323
```
2424

2525
- This is enabled by [mkdocs-site-urls](https://github.com/octoprint/mkdocs-site-urls) plugin.
26-
- This is preferred over *relative* links because of our complex structure. See tradeoffs [here](https://github.com/pedro-psb/pulp-docs/issues/2)
26+
- This is preferred over *relative* links because of our complex structure. See tradeoffs [here](https://github.com/pulp/pulp-docs/issues/2)
2727

2828

2929
### Codeblocks

‎staging_docs/index.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
- footer
6+
---
7+
8+
# Home {.hide-h1}
9+
<div class="hero-header" markdown>
10+
11+
![Pulp Logo](site:pulpcore/docs/assets/pulp_logo_big.png)
12+
13+
## 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}
14+
15+
</div>
16+
17+
---
18+
19+
<div class="grid cards" markdown>
20+
21+
- :material-clock-fast:{ .lg .middle } **Starter Tutorial**
22+
23+
---
24+
25+
Learn to manage content with Pulp and get yourself familiar with core concepts and workflows.
26+
27+
[:octicons-arrow-right-24: Getting started](site:pulpcore/docs/user/tutorials/01-overview/)
28+
29+
- :octicons-download-16:{ .lg .middle } **Pulp in a Container**
30+
31+
---
32+
33+
Use OCI (Open Container Initiative) images to install Pulp in single or multi-container setups.
34+
35+
[:octicons-arrow-right-24: Installation Quickstart](site:pulp-oci-images/docs/admin/tutorials/quickstart/)
36+
37+
- :octicons-rocket-16:{ .lg .middle } **Why Pulp?**
38+
39+
---
40+
41+
Learn why important projects rely on Pulp to manage the lifecyle of huge *Software Content* collections.
42+
43+
[:octicons-arrow-right-24: Features](#)
44+
45+
- :octicons-people-16:{ .lg .middle } **Get Involved**
46+
47+
---
48+
49+
Join our communication channels and get to know the contributors and users of Pulp's strong ecosystem.
50+
51+
[:octicons-arrow-right-24: Community](#)
52+
53+
</div>

‎staging_docs/sections/admin/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
hide:
33
- toc
44
---
5+
6+
# Admin Guide {.hide-h1}
7+
58
<div class="hero-header" markdown>
6-
<h1 class="landing-page-h1"></h1>
79

810
## This section is for **admins**
911

‎staging_docs/sections/dev/index.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
hide:
33
- toc
44
---
5+
6+
# Developer Guide {.hide-h1}
7+
58
<div class="hero-header" markdown>
6-
<h1 class="landing-page-h1"></h1>
79

810
## This section is for Pulp **developers**
911

‎staging_docs/sections/user/index.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
hide:
33
- toc
44
---
5-
<div class="hero-header" markdown>
65

7-
<h1 class="landing-page-h1"></h1>
6+
# User Guide {.hide-h1}
7+
8+
<div class="hero-header" markdown>
89

910
## This section is for **users**
1011

0 commit comments

Comments
 (0)