Skip to content
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

fix+enh(sphinx): Remove dup versions in title + weird title combination + don't use latest on older docs + add real version #11628

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

joshtrichards
Copy link
Member

@joshtrichards joshtrichards commented Mar 8, 2024

☑️ Resolves #7640

Summary

  • Eliminates duplicate version string appearing in HTML title (e.g. Introduction — Nextcloud latest Administration Manual latest documentation
  • Replaces latest with actual version string (or branch name if it's an arbitrary branch other than master or stableXX)
  • Replaces latest (for master doc builds) with upcoming to match their label on the https://docs.nextcloud.com + clearer indicate it's actually the documentation for the upcoming release of Nextcloud not necessarily the "latest"
  • Eliminates long version string that was included in the User Manual's chapter names

Caveat: Unless we backport this to all published older stableXX branches, all of the old documentation will continue to say latest. Once we merge we can try seeing how far back we can backport all this... Either way it'll be better for the most recent 3 releases (and going forward).

TODO:

  • Add v before version number
  • Handle unknown / master
  • Double check short title usage spots
  • Decide whether to drop Server from the titles (like it was previously)
  • Figure out why my PDF builds seem to not be using the theme

🖼️ Screenshots

Admin

Before:

html_title:

  • If master: Introduction — Nextcloud latest Administration Manual latest documentation
  • If stable28: Introduction — Nextcloud latest Administration Manual latest documentation
  • If stable27: Introduction — Nextcloud latest Administration Manual latest documentation
  • If randomBranch: Introduction — Nextcloud latest Administration Manual latest documentation

pdf:

image

After:

html_title:

  • If master: Introduction — Nextcloud Server (upcoming) Administration Manual
  • If stable28: Introduction — Nextcloud Server (28) Administration Manual
  • If stable27: Introduction — Nextcloud Server (27) Administration Manual
  • If randomBranch: Introduction — Nextcloud Server (randomBranch) Administration Manual`

pdf:

image

User

Before

html_title:

  • If master: Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
  • If stable28: Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
  • If stable27: Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
  • If randomBranch: Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation

toc:

image

After

html_title:

  • If master: Introduction — Nextcloud Server (upcoming) User Manual
  • If stable28: Introduction — Nextcloud Server (28) User Manual
  • If stable27: Introduction — Nextcloud Server (27) User Manual
  • If randomBranch: Introduction — Nextcloud Server (randomBranch) User Manual

toc:

image

PDF title page:

image

Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
@@ -1,8 +1,8 @@
.. _index:

============================================
Nextcloud |version| user manual introduction
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is shipped as PDF file with the release, that's why we want to have the version number in there, iirc

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see the PDF (at least in v27 and v28). The help page loads the HTML doc.

The version is still in the PDF - on the title page for example. It's just that now instead of always saying latest (including above) no matter what version of the doc someone is looking at - it'll say the actual version.

I can see putting it back on that particular page maybe in the first paragraph or something. But it's weird IMO to have it embedded in the ToC entry for the Introduction Chapter (even if we do make it the correct version). I can see having it in place for the "What's new" chapter maybe.

I'll re-look a bit more at it maybe tomorrow. Already took longer than planned since I hadn't messed with the PDF builds before. They're... a little weird. :)

Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The manual should indicate on the first page which version it refers to (pdf)
2 participants