Add authors to blogs#111
Conversation
src/pulp_docs/data/mkdocs.yml
Outdated
| blog_dir: blog | ||
| blog_toc: false | ||
| # The following path is weird but needed to account for the copying around all the files. | ||
| authors_file: ../../../../docs/sections/blog/.authors.yml |
There was a problem hiding this comment.
This path only seems to be valid for -e installations.
mdellweg
force-pushed
the
blog_authors
branch
2 times, most recently
from
b9387b0 to
31d8578
Compare
pyproject.toml
Outdated
| @@ -7,12 +7,13 @@ name = "pulp-docs" | |||
| version = "0.0.1" | |||
| requires-python = ">= 3.11" | |||
There was a problem hiding this comment.
The code uses Path.walk, which requires python>=3.12.
I think its ok to bump.
|
When you say you'd prefer to remove shims, you mean to completely remove the Can we first migrate to use mkdocs plugin and then work out the shim? Just by start using the plugins I believe we can already simplify some of the integration |
mkdocs.yml
Outdated
| plugins: | ||
| - PulpDocs: | ||
| plugins: | ||
| - name: pulpcore |
There was a problem hiding this comment.
I feel like this section should replace the repolist.yml that currently define the docs members and general settings.
There was a problem hiding this comment.
Indeed. I'm slowly getting there...
There was a problem hiding this comment.
About the structure, we'll have to add a on_nav event handler and adapt the get_navigation to build the structure we have.
I could write that one, I remember writing a lot of little details on the navigation builder.
There was a problem hiding this comment.
Yes, I've been trying to understand that. Can we instead of rewiring the nav change the paths of the files we include from the plugins accordingly?
There was a problem hiding this comment.
change the paths of the files we include from the plugins accordingly
Can you provide an example? I'm not sure if I can picture that.
Lets say we have file loaded as pulp_rpm/docs/admin/index.md.
But looking at the nav structure we have:
User Manual:
Content:
Pulp Rpm:
Admin:
So we would rename it to something like user_manual/content/pulp_rpm/admin/index.md to get the nav "automatically" created ?
Anyway, renaming things will break the links. I wanna put a link redirect plugin in-place, but not along with these changes.
|
I really want to make it so we call mkdocs directly. And for a transition phase add a very slim shim to call it as pulp-docs. |
mdellweg
force-pushed
the
blog_authors
branch
7 times, most recently
from
509f6b7 to
c7b1f45
Compare
mdellweg
force-pushed
the
blog_authors
branch
2 times, most recently
from
33ff50a to
92f957b
Compare
mdellweg
force-pushed
the
blog_authors
branch
10 times, most recently
from
679a9d1 to
cb7e71f
Compare
mdellweg
force-pushed
the
blog_authors
branch
4 times, most recently
from
a24c558 to
65b0a9b
Compare
…post Add missing image to the tasking system blog post
This will help to omit paths covered by _SUMMARY.md files.
|
|
2 participants
No description provided.