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

docs(contrib): update Syncthing GUI wrappers for Linux #886

Merged
merged 4 commits into from
Jan 5, 2025

Conversation

salim-b
Copy link
Contributor

@salim-b salim-b commented Dec 1, 2024

No description provided.

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

Thanks for your contribution. I must say I'm not really fond of introducing another level of headings here. Could you please simplify your patch to remove those again? Reordering is fine, to keep all GNOME Shell extensions together. Just not another two headings.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

Ist it ok with you to use a nested list à la

Linux

  • GNOME Shell extensions
    • Syncthing Icon <https://extensions.gnome.org/extension/989/syncthing-icon/>_

      A Syncthing status icon in the top bar.

    • Syncthing Indicator <https://extensions.gnome.org/extension/1070/syncthing-indicator/>_

      A Syncthing indicator for starting, monitoring and controlling the Syncthing daemon using systemd.

    • ...

  • Other
    • SyncThingy <https://github.com/zocker-160/SyncThingy>_

      Simple tray indicator written in C++ targeted at Flatpak users.

?

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

I guess with the current number of entries it's not worth the separation. That's personal opinion, partly based on a scientific writing rule I remember to only introduce a sub-level if there are at least three headings in it.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

I guess with the current number of entries it's not worth the separation.

I truly think it is since otherwise it doesn't immediately become clear for readers that the first entries are gnome shell extensions – only the URLs provide that hint.

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

Actually the description of each included the fact, until you removed it.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

Actually the description of each included the fact, until you removed it.

yup, because I think it's more elegant / less redundant that way

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

How about moving the distinction up one level?

Linux - GNOME Shell Extensions

Linux - Generic

I'm having a hard time coming up with a nice heading for the second category. One is pretty targeted (Steam Deck), the other two are for completely different environments, but more generic than only GNOME.

So if it's hard to make a meaningful separation, let's just not do it. "GNOME Shell" / "Not GNOME Shell" is not meaningful. It puts GNOME in a special position, which it doesn't have in our Syncthing world.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

I'm fine with moving the distinction up one level.

But I disagree with

"GNOME Shell" / "Not GNOME Shell" is not meaningful. It puts GNOME in a special position, which it doesn't have in our Syncthing world.

It's not about Gnome having a special position in Syncthing world but about it being one of many Linux DEs, so it's meaningful to all Linux users.

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

Sorry I don't get your argument. Yes, it's one of many DEs, I agree. My consequence from that is that it should not be the only one we specifically mention in Syncthing docs with its own heading / section / grouping.

Please, revert to the simple flat list under one "Linux" heading and we can apply the rest of your (sensible and welcome) fixes.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

My consequence from that is that it should not be the only one we specifically mention in Syncthing docs with its own heading / section / grouping.

Sure it shouldn't be, but it currently still is. Nothing hinders others to add more KDE-, Cosmic- or whatever specific software.

Anyways, I applied your suggestion :)

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

Sorry, you misunderstood. My suggestion was not something I am happy with, but just an idea to spark the discussion about the separation.

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

Well, I think the idea is fine and a good compromise until more DE-specific software is added.

@acolomb
Copy link
Member

acolomb commented Jan 5, 2025

I don't and frankly I didn't expect this to turn into a lengthy discussion. Conditions for merging have been stated. We can also merge as is and then revert the headings in another PR. But what's the point to that?

@salim-b
Copy link
Contributor Author

salim-b commented Jan 5, 2025

I'm just trying to serve Syncthing (Linux) users when grouping gnome shell extensions together. This is an improvement over the current status quo. Nothing hinders you from further improving on this once you "come up with a nice heading for the second category", as you wrote. :)

users/contrib.rst Outdated Show resolved Hide resolved
users/contrib.rst Outdated Show resolved Hide resolved
users/contrib.rst Outdated Show resolved Hide resolved
users/contrib.rst Outdated Show resolved Hide resolved
users/contrib.rst Outdated Show resolved Hide resolved
@acolomb acolomb merged commit 2d8ccd8 into syncthing:main Jan 5, 2025
3 checks passed
@salim-b salim-b deleted the patch-2 branch January 6, 2025 02:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants