-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
base: master
Are you sure you want to change the base?
Conversation
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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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. :)
Hello there, 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! |
☑️ Resolves #7640
Summary
latest
Administration Manuallatest
documentationlatest
with actual version string (or branch name if it's an arbitrary branch other thanmaster
orstableXX
)latest
(formaster
doc builds) withupcoming
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"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:
Addv
before version numberunknown
/master
Server
from the titles (like it was previously)🖼️ Screenshots
Admin
Before:
html_title:
master
:Introduction — Nextcloud latest Administration Manual latest documentation
stable28
:Introduction — Nextcloud latest Administration Manual latest documentation
stable27
:Introduction — Nextcloud latest Administration Manual latest documentation
randomBranch
:Introduction — Nextcloud latest Administration Manual latest documentation
pdf:
After:
html_title:
master
:Introduction — Nextcloud Server (upcoming) Administration Manual
stable28
:Introduction — Nextcloud Server (28) Administration Manual
stable27
:Introduction — Nextcloud Server (27) Administration Manual
randomBranch:
Introduction — Nextcloud Server (randomBranch) Administration Manual`pdf:
User
Before
html_title:
master
:Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
stable28
:Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
stable27
:Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
randomBranch
:Nextcloud latest user manual introduction — Nextcloud latest User Manual latest documentation
toc:
After
html_title:
master
:Introduction — Nextcloud Server (upcoming) User Manual
stable28
:Introduction — Nextcloud Server (28) User Manual
stable27
:Introduction — Nextcloud Server (27) User Manual
randomBranch
:Introduction — Nextcloud Server (randomBranch) User Manual
toc:
PDF title page: