A warning note, like the formerly used ones, was added to the installation section.
AbandonedPublic

Authored by asensi on Jan 8 2017, 9:36 AM.

Details

Reviewers
martinkostolny
yurchor
abika
Group Reviewers
Krusader

Diff Detail

Lint
Lint Skipped
Unit
Unit Tests Skipped
asensi updated this revision to Diff 9835.Jan 8 2017, 9:36 AM
asensi retitled this revision from to A warning note, like the formerly used ones, was added to the installation section. .
asensi updated this object.
asensi edited the test plan for this revision. (Show Details)
asensi added reviewers: Krusader, yurchor.
asensi added projects: Websites, Krusader.
asensi added a subscriber: Krusader.

I like the idea about the installation note! But is it necessary to pull another css? How about leaving a plain paragraph to visually align with another paragraphs under rest of headings? Something like:

<h3>Installation</h3>
<p>Please read the <a class="external" href="https://commits.kde.org/krusader?path=INSTALL">INSTALL</a> file of the Krusader sources, it contains all latest installation instructions.</p>

(adjusted diff:

)

But I'm really no UX expert so I might be wrong.

asensi added a comment.EditedJan 10 2017, 11:15 PM

Hi, Martin, the changes that you propose are good. The css file was added to achieve that the note:

Note
Please read the INSTALL file of the Krusader sources, it contains all latest installation instructions.

was seen the same way as the same notes that are seen in the Krusader Handbook (in docs.kde.org), for example in: https://docs.kde.org/trunk5/en/extragear-utils/krusader/kde_lin_install.html , https://docs.kde.org/trunk5/en/extragear-utils/krusader/compilation.html , etc.:

Note: In the docs.kde.org pages they use a https://docs.kde.org/trunk5/en/kdoctools5-common/kde-docs.css file, but if we try to use that file as-it-is in Krusader.org, then e.g. the page footers of Krusader.org get distorted.

If anyone brings a new solution, that would be nice. Anyway, the method that Martin proposed is good for me, too :-)

martinkostolny accepted this revision.Jan 15 2017, 3:35 PM
martinkostolny added a reviewer: martinkostolny.

I understand the motivation behind the additional css now, so I'm also fine with your proposed changes. We can always adjust it later if we change our minds :).

This revision is now accepted and ready to land.Jan 15 2017, 3:35 PM

I understand the motivation behind the additional css now, so I'm also fine with your proposed changes.

Ok! If users see the same style in the documents of krusader.org and in the Krusader handbook (which is placed in docs.kde.org), that's good.

We can always adjust it later if we change our minds :).

Yes, someone (maybe a KDE webmaster) may come with a better solution for that krusader.org - docs.kde.org CSS case :-)

abika requested changes to this revision.Jan 16 2017, 2:46 PM
abika added a reviewer: abika.
abika added a subscriber: abika.

Hmm, sorry I don't think the different style fits to the rest of the page. There are already a lot of Note:s . We should change all of them. But why a single (big) one with different style?

This revision now requires changes to proceed.Jan 16 2017, 2:46 PM

But why a single (big) one with different style?

The idea was to follow the Krusader handbook style (in docs.kde.org) to put out a big warning, in this case: "do not follow the next outdated information, it will cause you problems", "follow the linked file" :-) Like in https://docs.kde.org/trunk5/en/extragear-utils/krusader/compilation.html , https://docs.kde.org/trunk5/en/extragear-utils/krusader/kde_lin_install.html , etc. To achieve that the style avoids that the important note gets unnoticed. But we can find another way.

There are already a lot of Note:s .

There are a lot of notes which are not worrying enough, we can leave them as they are, with their current look :-)

abika added a comment.Jan 17 2017, 3:52 PM

The idea was to follow the Krusader handbook style (in docs.kde.org) to put out a big warning, in this case: "do not follow the next outdated information, it will cause you problems", "follow the linked file" :-)

If the instructions are outdated we should remove them all together. Better having only a link than stating wrong information.
But its more of the opposite: the current instructions (5 commands) should work well for most users.

There are a lot of notes which are not worrying enough, we can leave them as they are, with their current look :-)

Well, for now I changed the style for all notes and made them more visible.
And link to the INSTALL file is now included under the instructions. Is that good enough?

Hi!

the current instructions (5 commands) should work well for most users.

I would not recommend the information of that page, a line like

su -c "make install"

won't work for Debian/Mint/Ubuntu/Kubuntu/etc. users.
a line like

wget http://websvn.kde.org/*checkout*/trunk/l10n-kf5/de/messages/extragear-utils/krusader.po

does not work, it writes "ERROR 403: Forbidden.". The line

su -c "cp krusader.mo /usr/share/locale/de/LC_MESSAGES/"

misleads most users (because of the "su -c" and because of the "de"), and there were some other problems that led Davide and me to the improvement of the INSTALL file.

If the instructions are outdated we should remove them all together. Better having only a link than stating wrong information.

Better :-)

> There are a lot of notes which are not worrying enough, we can leave them as they are, with their current look :-)

Well, for now I changed the style for all notes and made them more visible.

I find that the style of those notes is good, I found good the former style of those notes, too :-)

And link to the INSTALL file is now included under the instructions. Is that good enough?

A lot of improvements were done. Thanks! Though, as stated before, the problems of the instructions of that page led Davide and me to the improvement of the INSTALL file.

yurchor edited edge metadata.EditedJan 17 2017, 8:21 PM
In D4008#78168, @asensi wrote:

Hi!

the current instructions (5 commands) should work well for most users.

I would not recommend the information of that page, a line like

su -c "make install"

won't work for Debian/Mint/Ubuntu/Kubuntu/etc. users.
a line like

wget http://websvn.kde.org/*checkout*/trunk/l10n-kf5/de/messages/extragear-utils/krusader.po

does not work, it writes "ERROR 403: Forbidden.". The line

su -c "cp krusader.mo /usr/share/locale/de/LC_MESSAGES/"

misleads most users (because of the "su -c" and because of the "de"), and there were some other problems that led Davide and me to the improvement of the INSTALL file.

There is a warning for sudo users in the current docs.

https://docs.kde.org/trunk5/en/extragear-utils/krusader/kde_lin_install.html

"de" can be put into the "replaceable" tag, like in docs.

https://docs.kde.org/trunk5/en/extragear-utils/krusader/starting-krusader.html

Adding -U "Mozilla/5.0" solves user agent problem for wget for me.

Thanks, there are solutions stated in the INSTALL file, I volunteer for adapting the web page :-)

abika added a comment.Jan 17 2017, 8:58 PM

I would not recommend the information of that page, a line like

su -c "make install"

won't work for Debian/Mint/Ubuntu/Kubuntu/etc. users.

Isn't sudo used for almost all distributions nowadays? We can replace it everywhere. And if somebody can compile Krusader he/she should know enough about Linux to get root access.)

Adding -U "Mozilla/5.0" solves user agent problem for wget for me.

For me too. Changed.

"de" can be put into the "replaceable" tag, like in docs.

Done.

A lot of improvements were done. Thanks! Though, as stated before, the problems of the instructions of that page led Davide and me to the improvement of the INSTALL file.

Sure, you should get access rights for the repo tomorrow.

In D4008#78221, @abika wrote:

I would not recommend the information of that page, a line like

su -c "make install"

won't work for Debian/Mint/Ubuntu/Kubuntu/etc. users.

Isn't sudo used for almost all distributions nowadays? We can replace it everywhere. And if somebody can compile Krusader he/she should know enough about Linux to get root access.)

I might be wrong, but this does not hold true outside Debian/Ubuntu world. At least, my distro (Mageia) does not use sudo by default.

asensi abandoned this revision.Jan 18 2017, 10:43 PM

Thanks for all the changes until now, it looks like it's better to follow the discussion in two new differentials:
https://phabricator.kde.org/D4194
https://phabricator.kde.org/D4195