sailfishos-chum / main

Documentation and issue tracker for the SailfishOS:Chum community repository
https://build.merproject.org/project/show/sailfishos:chum
MIT License
26 stars 4 forks source link

Beautify and adapt SailfishOS:Chum OBS-repository's description #45

Closed Olf0 closed 2 years ago

Olf0 commented 2 years ago

At https://build.sailfishos.org/project/meta/sailfishos:chum please change

<project name="sailfishos:chum">
  <title>SailfishOS Community repos</title>
  <description>SailfishOS Community repos&#13;
&#13;
See https://github.com/sailfishos-chum/main for documentation and issues.&#13;
&#13;
Ping piggz or rinigus at #sailfishos for help</description>

to

<project name="sailfishos:chum">
  <title>SailfishOS:Chum</title>
  <description>SailfishOS:Chum community repository&#13;
&#13;
A GUI-client for SailfishOS:Chum is available for easy installation at https://chumrpm.netlify.app/ and its individual RPMs are also provided at https://build.sailfishos.org/package/show/sailfishos:chum/sailfishos-chum-gui&#13;
A helper RPM, which solely provides an appropriate local repository configuration for utilising SailfishOS:Chum with command line tools as pkcon or zypper, is available at https://build.sailfishos.org/package/show/sailfishos:chum/sailfishos-chum&#13;
&#13;
See https://github.com/sailfishos-chum/main for documentation, guidance, rules and the issue tracker.&#13;
You may also ping piggz or rinigus at the IRC channel #sailfishos for help.&#13;</description>

This aligns this description and its wording with PR #44 and https://github.com/sailfishos-chum/sailfishos-chum-gui/pull/85

P.S.: I hope that my guess that #sailfishos denotes an IRC channel (and not some Telegram group etc.) is correct.

rinigus commented 2 years ago

Done. Similar notation has been used for chum:testing repo as well

Please check and close the issue if it is fixed

Olf0 commented 2 years ago

Thank you, we are almost there, but not fully yet:

Hence another try, this time separately for both pages:

  1. https://build.sailfishos.org/project/show/sailfishos:chum
    <project name="sailfishos:chum">
     <title>SailfishOS:Chum</title>
     <description>SailfishOS:Chum community repository&#13;
    &#13;
    &#13;
    A full-featured GUI-client and a minimalistic helper RPM (which solely provides a local repository configuration) for utilising the SailfishOS:Chum repository are available for easy installation at https://chumrpm.netlify.app/&#13;
    &#13;
    For SailfishOS:Chum's documentation, guidance, rules and issue tracker, see https://github.com/sailfishos-   chum/main&#13;
    &#13;
    You may also ping piggz or rinigus at the IRC channel #sailfishos for help.&#13;
    &#13;
    </description>
  2. https://build.sailfishos.org/project/show/sailfishos:chum:testing
    <project name="sailfishos:chum:testing">
     <title>SailfishOS:Chum:Testing</title>
     <description>SailfishOS:Chum testing repository&#13;
    &#13;
    &#13;
    This repository is used for evaluating packages before they are promoted to the main repository.&#13;
    To submit a new or updated package, create it under your own account and submit it per OBS' "Submit package" action.&#13;
    &#13;
    For SailfishOS:Chum's documentation, guidance, rules and issue tracker, see https://github.com/sailfishos-chum/main&#13;
    &#13;
    You may also ping piggz or rinigus at the IRC channel #sailfishos for help.&#13;
    &#13;
    </description>


HTH & hope that looks better than v1.

rinigus commented 2 years ago

Updated. Had to add one more linebreak in :testing to split the paragraphs. Hopefully, its OK now :)

Olf0 commented 2 years ago

v3:

  1. https://build.sailfishos.org/project/show/sailfishos:chum (identical to v2)
    <project name="sailfishos:chum">
     <title>SailfishOS:Chum</title>
     <description>SailfishOS:Chum community repository&#13;
    &#13;
    &#13;
    A full-featured GUI-client and a minimalistic helper RPM (which solely provides a local repository configuration) for utilising the SailfishOS:Chum repository are available for easy installation at https://chumrpm.netlify.app/&#13;
    &#13;
    For SailfishOS:Chum's documentation, guidance, rules and issue tracker, see https://github.com/sailfishos-   chum/main&#13;
    &#13;
    You may also ping piggz or rinigus at the IRC channel #sailfishos for help.&#13;
    &#13;
    </description>
  2. https://build.sailfishos.org/project/show/sailfishos:chum:testing (solely the word "staging" added)
    <project name="sailfishos:chum:testing">
     <title>SailfishOS:Chum:Testing</title>
     <description>SailfishOS:Chum testing repository&#13;
    &#13;
    &#13;
    This staging repository is used for evaluating packages before they are promoted to the main repository.&#13;
    To submit a new or updated package, create it under your own account and submit it per OBS' "Submit package" action.&#13;
    &#13;
    For SailfishOS:Chum's documentation, guidance, rules and issue tracker, see https://github.com/sailfishos-chum/main&#13;
    &#13;
    You may also ping piggz or rinigus at the IRC channel #sailfishos for help.&#13;
    &#13;
    </description>

If you are tired of these nitpicking changes, never mind. But they make these two texts more consistent (both with two line breaks after the subtitle) and the two sentences IMO logically form a paragraph together, so they shall not be split.

rinigus commented 2 years ago

Taking into account that these texts are mostly for developers and not of interest for users, I suggest to stop fine tuning them. I think they are good enough and its better to focus on more important issues

PawelSpoon commented 2 years ago

when we talk about the readme.md i am to stupid to understand the simplified process of check-in. and as a consequence i bother you guys on each update with submit package requests as i just found out. can you please improve that or give me a hint ? thanks ! ok i did accept my own request and version now ended in :testing

rinigus commented 2 years ago

@PawelSpoon: yes, it is manual at this stage when we accept in sailfishos:chum. But don't worry about bothering, it is a part of the design. So, you are expected to make it ready in sailfishos:chum:testing and then make submit request

sailfishos:chum:testing -> sailfishos:chum

We try to process ASAP, but it may take few hours depending on our timezone, work engagement.

Olf0 commented 2 years ago

@PawelSpoon,

ok i did accept my own request and version now ended in :testing

Do you feel that is some information missing in the README.md? I.e., do you think that a (half-) sentence denoting this should be added to README.md#how-to-use-the-sailfishoschum-repository-developers-guide?

If so, can you please make a suggestion in a new issue or a PR (because the last three messages already have been off-topic for this issue).

Olf0 commented 2 years ago

@rinigus,

Taking into account that these texts are mostly for developers and not of interest for users, …

I would like to agree, but multiple user-guides direct users to these pages, e.g. Announcing sailfishos:chum.

I suggest to stop fine tuning them. I think they are good enough and its better to focus on more important issues

Which in this context is to enhance the alternatives to …

  1. browsing RPMs there to install them at the command line.
  2. download SailfishOS:Chum repo config RPM from there to perform 1.
  3. download the SailfishOS:Chum GUI app RPM from there.
rinigus commented 2 years ago

@Olf0: I have been thinking if we could push GUI into the official store. Not sure whether communication with SSU or PackageKit is allowed there. Haven't look into it yet, unfortunately.

Olf0 commented 2 years ago

@Olf0: I have been thinking if we could push GUI into the official store.

That would be a really easy and nice way out, but …

Not sure whether communication with SSU or PackageKit is allowed there.

I doubt that.

Haven't look into it yet, unfortunately.

Me, too.

Olf0 commented 2 years ago

… furthermore I do not remember that the Jolla Store does support deploying different RPMs depending on the installed SailfishOS release. If so, this approach has massive drawbacks.

IMO the only viable way is a noarch installer RPM, this is why I pointed to sailfishos-chum-gui issue 96 for a potential long-term solution.

Until then, merging sailfishos-chum-web PR 4 would bring an enhancement ("quick win") for the current workaround.

rinigus commented 2 years ago

I am not currently aware of the code that would require different versions on the same arch for different SFOS releases. As we fixed the issues encountered by you on older SFOS, it could work via Jolla Store. Just (most probably) we will hit some policy prohibiting it

Olf0 commented 2 years ago

I am not currently aware of the code that would require different versions on the same arch for different SFOS releases.

So the necessity to select an SFOS release at https://chumrpm.netlify.app/ is just a superfluous complication?!? Then this webpage and its source repository also are good for nothing, because the SailfishOS:Chum GUI app could be easily deployed via OpenRepos?

As we fixed the issues encountered by you on older SFOS, it could work via Jolla Store.

O.K.; that would be really nice. If only we both would not hesitate out of experience that …

Just (most probably) we will hit some policy prohibiting it.

rinigus commented 2 years ago

So the necessity to select an SFOS release at https://chumrpm.netlify.app/ is just a superfluous complication?!?

Yes, pretty much, I believe.

Then this webpage and its source repository also are good for nothing, because the SailfishOS:Chum GUI app could be easily deployed via OpenRepos?

yes, in principle. Although, it is a bit bizarre when you have to hop through OpenRepos to end up in Chum. So, we better either make it possible to install via Store or have an easier online download.

Olf0 commented 2 years ago

So the necessity to select an SFOS release at https://chumrpm.netlify.app/ is just a superfluous complication?!?

Yes, pretty much, I believe.

For sure, and for both RPMs. One is also a noarch RPM, thus both enforced, manual choices are completely unnecessary for it.

Then this webpage and its source repository also are good for nothing, because the SailfishOS:Chum GUI app could be easily deployed via OpenRepos?

yes, in principle. Although, it is a bit bizarre when you have to hop through OpenRepos to end up in Chum.

This would be far less bizarre than either to go to an awkwardly looking web-page at an unknown hoster, to perform two manual choices there to ultimately download an RPM, which has to be manually installed, or to perform the same actions fully manually at the SailfishOS:Chum OBS (which you defined as "for developers"). Especially for everybody already using Storeman; but even if one can manually download this RPM from OpenRepos, because OpenRepos is a well known location.

So, we better either make it possible to install via Store or have an easier online download.

Via Jolla Store or OpenRepos does not make any difference for many, likely most SailfishOS users willing to use SailfishOS:Chum.

Though I sure support to "have an easier online download", this is exactly why I created sailfishos-chum-web PR 4 and contributed to a bug report, but apparently no one seems to care. But despite improvements, this web-page always will be an awkward workaround, much more tedious, inconvenient and questionable (without any indication of being trustworthy) than using Storeman (or the Jolla Store app).

rinigus commented 2 years ago

Re unknown hoster: good point. Maybe we should add those RPMs into this repo releases. We could make some version that would later be just updated at OBS. That way RPMs will be coming from a repo that is associated with the project. Although, that "unknown hoster" should be actually providing links to OBS

I am not maintainer of -chum-web and I don't know how that web app gets enrolled.

As for OpenRepos, yes, maybe we should put it there as well.

Now in terms of making it happen - I'd love to spend a bit of time on other projects. Just few days or a week :)

Olf0 commented 2 years ago

Although, that "unknown hoster" should be actually providing links to OBS

Well, if I ever get stuff merged there, I have https://github.com/Olf0/sailfishos-chum-web/pull/1/commits/72d82a08395bc31f9bbb361b6f18b985b735d849 in store.

I am not maintainer of -chum-web and I don't know how that web app gets enrolled.

Right now I would be glad to see any reaction from @mentaljam. Piling up more issues, changes, commits and PRs does not make sense without maintainer's feedback (even silently merging would do).

As for OpenRepos, yes, maybe we should put it there as well.

Well, I avoided to address the consistent use of "we", but here I do have to ask who "we" is? I could, but it would be awkward to distribute somebody else's work, and I hardly can be the maintainer at OpenRepos without being involved (at least "in the loop" / notified) of maintenance work at GitHub. You may be better suited, but ultimately @mentaljam seems to be the "natural candidate".

rinigus commented 2 years ago

We would be me, @piggz, @mentaljam. I wouldn't mind you to take GUI RPMs and set them up at OpenRepos. You seem to be very well in the loop already :)

Olf0 commented 2 years ago

I wouldn't mind you to take GUI RPMs and set them up at OpenRepos.

Done: https://openrepos.net/content/olf/sailfishoschum-gui-client-app & https://openrepos.net/content/olf/sailfishoschum-repo-config-rpm

You seem to be very well in the loop already :)

I am merely a contributor, who tried to enhance the visual appeal and usability of the SailfishOS:Chum infrastructure (software, documentation etc.) to a point where it looses the look & feel of being "done by students in their spare time" (a phrase a colleague of mine at work coined, which fits well to many FLOSS projects, even some "big" ones); IMO this was (and still is: a couple of PRs are not merged yet) just a first step towards a more professional appearance for many infrastructure components of SailfishOS:Chum with the long-term goal in mind of "The ambition is to become the principal software distribution platform for Sailfish OS".

As mentioned before, most techies vastly underestimate the impact of appearance on non-techies: Because they have nothing else to base their judgement upon, the "look & feel" is what they evaluate, while all the things techies are proud of (quality of the source code etc.) are (rsp., "must implicitly be") meaningless to them.

As said and now also stated in the README, I did appreciate the concept of F-Droid (a repo with semi-automatic builds from contributed sources) much for long and love to see it applied to the SailfishOS ecosystem. This is why I supported SailfishOS:Chum by roughly enhancing an aspect which did not seem to be much in your focus yet: a proper "look & feel" (appearance and usability).

rinigus commented 2 years ago

This is an excellent example where we can very well contribute bits to build something bigger. I am happy that you took this part of the project and work on the design and overall appearance. It will surely translate into more users and developers working via SailfishOS:Chum :)

rinigus commented 2 years ago

While Chum GUI got just released (minor version bump), we can keep older GUI binaries at OpenRepos as GUI gets updated by itself through Chum anyway. So, in this respect, we need to update OpenRepos release only occasionally.

Olf0 commented 2 years ago

While Chum GUI got just released (minor version bump), we can keep older GUI binaries at OpenRepos as GUI gets updated by itself through Chum anyway. So, in this respect, we need to update OpenRepos release only occasionally.

Well, now "we" is me. :wink: More seriously: Yes, I already considered that, too.

But specifically for the last upload of the sailfishos-chum-gui RPM v0.4.0, I have to redo it any way, because I did not think enough before acting: I picked the variants compiled for SailfishOS 4.3.0, of which the one for armv7a failed to install later when testing on my XperiaX@SFOS3.2.1. That "C++ ABI mismatch" error was to be expected, in hindsight. :frowning_face:

Thus I plan to upload the sailfishos-chum-gui RPM v0.4.1 compiled for SFOS 3.1.0 (rsp. SFOS 4.0.1 for aarch64) at OpenRepos, next. Do you expect any issues when installing this on recent SailfishOS releases?

rinigus commented 2 years ago

I was mistaken - cannot use GUI for SFOS 4.0.1 (oldest version for aarch64) on 4.3. At least not as it is now. There is something preventing it from starting when using app grid. I guess related to the bug you had with the invoker :( .

Cannot test very old SFOS releases, unfortunately.

Olf0 commented 2 years ago

I was mistaken - cannot use GUI for SFOS 4.0.1 (oldest version for aarch64) on 4.3. At least not as it is now. There is something preventing it from starting when using app grid. I guess related to the bug you had with the invoker :( .

:frowning: O.K., I deleted my recent uploads of the sailfishos-chum-gui RPM v0.4.1 compiled for SFOS 3.1.0 (rsp. SFOS 4.0.1 for aarch64) at OpenRepos, and uploaded the variants compiled for SFOS 4.3.0.

So currently it makes only sense to offer the sailfishos-chm-gui variants compiled for the current SFOS release at OpenRepos, but this is probably only useful for users of exactly this SFOS release.

Maybe Slava Monich's harbour-lib is helpful here for implementing a proper solution.

Until then my one-man-show at sailfishos-chum-web PR 4 would still provide a quick improvement (though only visually and WRT clarity of the text), if it is ever reviewed, maybe merged and even uploaded to chumrpm.netlify.app.

Cannot test very old SFOS releases, unfortunately.

Well, I can, did and do (at least ARMv7A@SFOS3.2.1): Variants compiled for SFOS ≥ 3.4.0 fail, as mentioned.

rinigus commented 2 years ago

Makes sense to have latest GUI version on OpenRepos. We will have to revise options for GUI installer and then look what to do about it. I can look into it, hopefully tonight after work

Olf0 commented 2 years ago

This discussion thread deviated far enough from the original issue topic (which is basically resolved) to be closed.

The remaining issues should be discussed elsewhere, the most prominent (and last discussed here) at SailfishOS:Chum GUI issue 96.