Differential D20389

doc: drop almost all bits related to installation
ClosedPublic
Actions

Authored by pino on Apr 8 2019, 7:02 PM.

Details

Reviewers

Commits

R261:6bffb7d0d9b6: doc: drop almost all bits related to installation

Summary

In the majority of the cases, users install kmymoney as available in
their distribution, and thus most of this content is not useful; users
that want to compile kmymoney from sources find already instructions on
kmymoney.org, in the development wikis, and in the in-source files, so
no need to duplicate them in a user-taylored documentation.

Furthermore, the current building instructions are outdated, and an
updated version, together with any FAQ related to building from sources
and developing on kmymoney, belongs to online resources (easier to keep
up-to-date).

Test Plan

build the documentation
verify the mentioned bits are not present

Diff Detail

Repository

R261 KMyMoney

Branch

doc-no-build-install (branched from master)

Lint

No Linters Available

Unit

No Unit Test Coverage

Build Status

Buildable 10632
Build 10650: arc lint + arc unit

pino created this revision.Apr 8 2019, 7:02 PM

Restricted Application added a project: Documentation. · View Herald TranscriptApr 8 2019, 7:02 PM

Restricted Application added a subscriber: kde-doc-english. · View Herald Transcript

pino requested review of this revision.Apr 8 2019, 7:02 PM

Harbormaster completed remote builds in B10632: Diff 55769.Apr 8 2019, 7:02 PM

pino added a subscriber: KMyMoney.Apr 8 2019, 7:02 PM

tbaumgart added a reviewer: ostroffjh.Apr 8 2019, 8:21 PM

I've just returned from vacation, and there is currently a string/doc freeze, so please give me some days to review, but I'll probably agree. However, I would like to be sure the info from those Q&A sections is maintained somewhere - probably on a web page with the install info specifically for KMM.

In D20389#446784, @ostroffjh wrote:

I've just returned from vacation, and there is currently a string/doc freeze, so please give me some days to review, but I'll probably agree.

No problem, take your time. Note this is targeted for master, not for 5.0.

However, I would like to be sure the info from those Q&A sections is maintained somewhere - probably on a web page with the install info specifically for KMM.

The closest thing is https://techbase.kde.org/Projects/KMyMoney, which is outdated as well...
So IMHO the best idea is to just put all the developer resources in this page, rather than in an end-user-targeted documentation.

... though it might be OK for 5.0 as well (after the freeze). Cleaning up the documentation is a good idea in general. I am all for updating our techbase page. I have a gut feeling that this stuff hasn't been touched in ages. Thanks to all for their contributions.

There's no point in delaying this any further. It can be applied to 5.0 and master branches. (I'm not certain if all the recent doc updates to 5.0 have been applied to master, but I think Thomas has merged the 5.0 branch into master recently enough.)

This revision is now accepted and ready to land.May 9 2019, 5:09 PM

pino closed this revision.May 9 2019, 7:46 PM