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

Help menu: link to online manual only, remove obsolete 2.2 manual #3712

Closed
wants to merge 1 commit into from

Conversation

ronso0
Copy link
Member

@ronso0 ronso0 commented Mar 15, 2021

No description provided.

@ronso0 ronso0 added this to the 2.3.0 milestone Mar 15, 2021
@github-actions github-actions bot added the ui label Mar 15, 2021
@ronso0 ronso0 added code quality and removed ui labels Mar 15, 2021
@ronso0 ronso0 marked this pull request as draft March 15, 2021 23:21
@ronso0 ronso0 marked this pull request as ready for review March 15, 2021 23:22
@Be-ing
Copy link
Contributor

Be-ing commented Mar 15, 2021

We should update the manual build instead of removing it.

@ronso0
Copy link
Member Author

ronso0 commented Mar 16, 2021

IIRC we agreed on not delivering the 3.6MB manual with the binaries?
(the manual is not mentioned anywhere in /packaging/ therefore I seem to recall correctly)
Btw, currently even opening the local manual is broken on Linux.

With the web version we can keep updating and improving the manual without users requiring to update, and we probably won't make a point release just for an updated manual.

@Be-ing
Copy link
Contributor

Be-ing commented Mar 16, 2021

IIRC we agreed on not delivering the 3.6MB manual with the binaries?

Huh? Where was that discussed?

Viewing the manual should not require Internet access. The current situation requiring manual rebuilds of the PDF is hacky but we won't be improving that until 2.4 with #3047.

@ronso0
Copy link
Member Author

ronso0 commented Mar 16, 2021

I thought that was discussed when @hozhaus revamped the entire manual process.

@Holzhaus
Copy link
Member

Holzhaus commented Mar 16, 2021

We could include the PDF manual by adding a CMake option for it that fetches the PDF from downloads.mixxx.org at configure time. But we can also not include it, I'm fine with it either way.

@ronso0
Copy link
Member Author

ronso0 commented Mar 16, 2021

okay, nevemind.

https://github.com/mixxxdj/mixxx/blob/main/src/widget/wmainmenubar.cpp#L574
if (resourceDir.cd("../doc/mixxx") && resourceDir.exists(MIXXX_MANUAL_FILENAME)) {

this fails because the manual is compressed and installed as Mixxx-Manual.pdf.gz

continued in https://mixxx.zulipchat.com/#narrow/stream/109176-documentation/topic/2.2E3.20manual.20PDF

@ronso0 ronso0 closed this Mar 16, 2021
@ronso0 ronso0 deleted the manual-link branch March 16, 2021 01:14
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.

3 participants