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

Community: Update Gitter links to Matrix, Update Badges, Remove editor extensions #9898

Merged
merged 12 commits into from
Mar 27, 2023

Conversation

kbdharun
Copy link
Member

@kbdharun kbdharun commented Feb 27, 2023

Changes

  • Update Gitter Links to Matrix.
  • Discussion: here

@kbdharun kbdharun added decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. community Issues/PRs dealing with role changes and community organization. labels Feb 27, 2023
@github-actions github-actions bot added documentation Issues/PRs modifying the documentation. tooling Helper tools, scripts and automated processes. labels Feb 27, 2023
@SethFalco
Copy link
Member

SethFalco commented Feb 27, 2023

My understanding was that we wanted to link directly to Element, i.e.

https://app.element.io/#/room/#tldr-pages:matrix.org

To simplify the experience for users that don't know what Matrix, and to make it easy to join the chat without having to make decisions like what client to use.

By using Element, users are able to sign-up, sign-in, and if they already have a Matrix account they can specify the home-server and login. Unlike on Gitter where if one is already on Matrix, that would make them essentially create a new account without the option to use their existing one.

Reference: https://matrix.to/#/!zXiOpjSkFTvtMpsenJ:gitter.im/$7cbPucUQDlK4Gz5upQ7To2IAGU_pos3N74K_B0-UhVg?via=gitter.im&via=matrix.org&via=one.ems.host

Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
url: https://matrix.to/#/#tldr-pages:matrix.org
about: Matrix view of our Gitter chat rooms
url: https://matrix.to/#/#tldr-pages-project:matrix.org
about: Matrix space of our chat rooms
Copy link
Member

@waldyrious waldyrious Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if we should avoid referring people to the space, as that's a slightly confusing aspect of Matrix still, and not very useful in the context of issue creation anyway. Maybe we should just drop this link. That would have the added benefit of making having one fewer link in the issue creation menu, which is always a benefit with this sort of intermediate step where people are just trying to get things done.

Copy link
Member Author

@kbdharun kbdharun Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that seems better I applied the changes, let's see what others think too.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to allow others to chime in, we shouldn't mark the conversation as resolved :)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to allow others to chime in, we shouldn't mark the conversation as resolved :)

Agreed, seems like I forgot to unresolved it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally don't see the issue with spaces myself.
It's similar to workspaces on Slack, or servers/guilds on Discord. A fairly well-known concept.

While Matrix does this a bit differently from other platforms, the surface-level UX should be familiar.

However, in the end it makes little difference while we don't have many rooms I guess. So whatever works. 😅

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So whatever works. 😅

Yeah

- name: Gitter chat
url: https://gitter.im/tldr-pages/tldr
- name: Chatroom
url: https://matrix.to/#/#tldr-pages:matrix.org
about: You can ask and answer questions here
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe something more relevant to the issue creation flow?

Suggested change
about: You can ask and answer questions here
about: Consider joining the chat room to discuss your issue, question or suggestion with the community before opening an issue.

(Note: I didn't mull over this wording a lot, it's just a quick suggestion to get the ball rolling.)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good to me

Copy link
Member

@waldyrious waldyrious Feb 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep this conversation unresolved for a while longer, so others can offer their thoughts as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with adding the comma after "question" :) I don't think that in this case it would make a difference, but it doesn't hurt either.

Btw, I didn't participate in the discussion to add that section, but I wonder if it's really such a prevalent and/or contentious issue that it requires being included in the style guide... 🤔 Besides, the example given there strikes me as odd since the first ambiguous interpretation relies on usage of the comma in a place where there isn't a clause boundary (I'm sure there's a name for that — it's the opposite of a comma splice) but anyway, both of these observations are topics for a separate discussion.

Copy link
Member

@SethFalco SethFalco Feb 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, I didn't participate in the discussion to add that section

I don't mind revising/scrapping it if you have reservations with it. I'm probably one of the few people that care anyway, though ofc we should include everyone anyway. ^-^'

I don't think that in this case it would make a difference

You're right, it doesn't make a difference. I just think it's nice to stick to one or the other rather do it sometimes and not other times.

This may be the wrong way to think of it, but I treat it similar to how once does curly braces in code. Either opt for the comma or don't, but doing it just sometimes is a bit shoddy.

Edit: Also, this may be subjective, but just reading it out loud, the extra comma just sounds more fitting. (Try it yourself!)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was going to reply with a different perspective, but honestly, that's just splitting hairs at this point. Let's go with the comma, and avoid derailing this thread to much (if anything, for the sake of who may read this thread in the near or far future — as @kbdharun discovered recently, trawling through long discussions is kind of a drag 😅)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure sure, sorry to be a pain here though. ^-^'

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not at all, I actually had to catch myself before going on that tangent — I think it's only natural that people who are attracted to this project share this kind of attention to detail in writing :)

COMMUNITY-ROLES.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
MAINTAINERS.md Outdated Show resolved Hide resolved
kbdharun and others added 2 commits February 27, 2023 21:48
Co-authored-by: Waldir Pimenta <waldyrious@gmail.com>
@kbdharun kbdharun linked an issue Feb 28, 2023 that may be closed by this pull request
Copy link
Member Author

@kbdharun kbdharun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated README Badges
image

@SethFalco
Copy link
Member

SethFalco commented Feb 28, 2023

I personally prefer all lowercases badges, but that's subjective.
It's certainly more common among providers/services that offer badges of some kind, I was under the impression it was psuedo-standardized but maybe that'd be inaccurate to say. 🤔

i.e.

  • Shields.io
  • Badgen
  • GitLab - Only referring to the built-in badges, custom ones can ofc be uppercase
  • SonarQube - link is to an issue showing the badges sinces they're not shown in the docs
  • Gitter - Even the old Gitter badge was all lowercase by default

If you look at the top projects on GitHub, you'll find most (not all) shields/badges are in lowercase too.

i.e. look at any of the trending repos atm:


Anyone else have any thoughts here?

@waldyrious
Copy link
Member

I don't have strong opinions on the capitalization of the badges. I agree the lowercase convention is more prevalent, but the capitalized version doesn't look jarring to me (and in fact it may look awkward if we include the "on Matrix" suffix for the chat badge). I'm happy to heed any consensus that emerges here, though.

@kbdharun kbdharun changed the title Community: Update Gitter links to Matrix Community: Update Gitter links to Matrix, Update Badges Feb 28, 2023
@SethFalco
Copy link
Member

We can just run with the title cases versions. @kbdharun made the change already after all, so I think it's safe to assume they like it, and I guess it's not a big deal. Sorry to be picky!

@waldyrious
Copy link
Member

Sorry to be picky!

Don't be sorry, picky people is how quality is achieved ;)

kbdharun added a commit to tldr-pages/tldr-node-client that referenced this pull request Mar 11, 2023
@kbdharun kbdharun changed the title Community: Update Gitter links to Matrix, Update Badges Community: Update Gitter links to Matrix, Update Badges, Remove editor extensions Mar 11, 2023
@kbdharun
Copy link
Member Author

Hi guys, any updates on this?

@kbdharun kbdharun merged commit 46ab966 into tldr-pages:main Mar 27, 2023
kbdharun added a commit to tldr-pages/tldr-node-client that referenced this pull request Mar 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Issues/PRs dealing with role changes and community organization. decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. documentation Issues/PRs modifying the documentation. tooling Helper tools, scripts and automated processes.
Projects
Development

Successfully merging this pull request may close these issues.

[Archive] MAINTAINERS: Gitter Chat of Old Room before Matrix bridge
4 participants