Skip to content

Section-level re-structures #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 22, 2024
Merged

Conversation

pedro-psb
Copy link
Member

@pedro-psb pedro-psb commented Feb 20, 2024

What this does

  • Remove the "common" Reference section in favor or persona-scoped Reference (as everything else)
    • TLDR: use staging_docs/{persona}/reference instead of the global staging_docs/reference.
    • I've suggested a common reference before because I was unsure how reference could be persona-scoped. After seeing more real content, I'm convinced that we should scope them for both consistency and convenience.
  • Re-organize Section overviews (user,admin,dev manuals)
    • Move responsibility for those from pulpcore to pulp-docs, because these "sections content" are highly coupled with the navigation that pulp-docs define.
    • Add some fancy tiles for most useful links/paths
    • Add "Quick Links" table (auto-generated) for each of them with version and links for rest-api, github and changelog. I've found myself wishing for this sometimes, and I hope it will be generally useful.
  • Re-organize "Help" Section.
    • Move changelogs there. It is not quite the right place, but I guess its reasonable, as we have "Quick Links" table now. An alternative is move it to its own top-level section (as I've removed "Reference" from there, it has some "space left").
    • Move "Get Involved", "Code of Conduct" and "Privacy Policy" from main Pulp site here. I've also re-written "Get Involved" so its more succint.
    • Add placeholder Tutorial (probably) called "Documentation Usage", for explaining the foundation concepts of the content organizations and the website structure and how to leverage them to find things.

Screenshots

Section Overviews

This is similar to user and admin.

image

Help Page

image

@pedro-psb pedro-psb changed the title Reorganize Reference section Section-level re-structures Feb 22, 2024
@pedro-psb pedro-psb marked this pull request as ready for review February 22, 2024 12:36
@pedro-psb pedro-psb force-pushed the re-organize-reference-section branch from 0a981d8 to ccf2d13 Compare February 22, 2024 14:45
@pedro-psb pedro-psb merged commit 262165d into main Feb 22, 2024
@pedro-psb pedro-psb deleted the re-organize-reference-section branch February 22, 2024 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant