Skip to content

matrix: Add initial docs (closes #11) #27

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

Merged
merged 1 commit into from
Feb 16, 2020
Merged

matrix: Add initial docs (closes #11) #27

merged 1 commit into from
Feb 16, 2020

Conversation

justjwheelin
Copy link
Member

@justjwheelin justjwheelin commented Feb 12, 2020

This commit is a first-pass explainer to what Matrix/Riot are and how we use them in the FOSS@RIT community. It also collects some of the rooms I know about but is probably not a complete list.

Closes #11.

I'd like to get two, or maybe even three, reviews on this doc since a lot of folks use Matrix in our community. I requested a review from Tech Team, but also tagged a few people whose eyes I'd like to borrow. 👀

Screenshot of rendered page from local development environment

@justjwheelin justjwheelin added new change Adds new capabilities or functionality docs - infra Infrastructure, web services, and standard operating procedures labels Feb 12, 2020
@justjwheelin justjwheelin self-assigned this Feb 12, 2020
@justjwheelin justjwheelin changed the title matrix: Add initial docs matrix: Add initial docs (closes #11) Feb 12, 2020
Copy link
Member

@Tjzabel Tjzabel left a comment

Choose a reason for hiding this comment

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

LGTM

@Alch-Emi
Copy link

Response to an informal invitation to review

Looks good to me!

There's a few small things I might change/add. (None of very high importance, though)

  • I might note that communities as they are currently implemented are not long for this world, and will be replaced with Groups-As-Rooms once MSC 1772 gets merged
  • Also, it's kinda a small thing, but I have a really hard time reading the last sentence of the How we use matrix paragraph, even knowing what you're trying to say. Maybe something like "Many of our users use the Matrix network, but can communicate seamlessly with the IRC rooms", if I understood your original meaning correctly?
  • It might be useful to add a super short blurb to the "Known Rooms" table with a description of each room. It's not super important, since you can kinda tell based off of the name of the room, but it could also help make it a little bit more clear.

All of that is really just clarity though, and whether or not you want to add them is up to you. Overall, I think it works really well and is a really good description of the relation of FOSS and Matrix


Addendum: The Riot screenshot used to illustrate communities uses the legacy Riot client, which is most likely not what new Riot users will be using/seeing. It might be helpful to use a screenshot from the redesigned client, so that users might better understand it in context. Something like the attached might be good, though feel free to use a different screenshot, ofc

A screenshot of the updated Riot.im interface, with the "communities" button highlighted

justjwheelin added a commit that referenced this pull request Feb 16, 2020
Changing some wording, updating the screenshot.

Signed-off-by: Justin W. Flory <git@jwf.io>
@justjwheelin
Copy link
Member Author

Thanks for reviewing @Alch-Emi! 👍 I addressed most of your feedback in commit fd891c6. I decided against adding the description field to the known rooms, because of a limitation where the tables will flow off-screen if too much text is added. I think the room preview in Matrix/Riot will be enough for most cases.

Copy link
Member

@ct-martin ct-martin left a comment

Choose a reason for hiding this comment

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

@jwflory these would be helpful for the "how we use matrix" section due to how often they get sent to people:

https://opensource.com/article/17/5/introducing-riot-IRC
https://github.com/matrix-org/matrix-appservice-irc/wiki/End-user-FAQ#how-do-i-registeridentify-to-nickserv

justjwheelin added a commit that referenced this pull request Feb 16, 2020
Added some frequently-referenced links for using Matrix.

Signed-off-by: Justin W. Flory <git@jwf.io>
@justjwheelin
Copy link
Member Author

Thanks @ct-martin, I addressed your feedback in commit 99d8842. 👍

@Tjzabel
Copy link
Member

Tjzabel commented Feb 16, 2020

@Alch-Emi what do you mean, legacy Riot client?

Copy link
Member

@jibby0 jibby0 left a comment

Choose a reason for hiding this comment

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

The IRC (Freenode) link under How we use Matrix (https://github.com/FOSSRIT/runbook/blob/master/docs/infra/irc) brings me to a 404

Otherwise LGTM: a nice introduction + good links for further reading :)

Copy link
Member

@ct-martin ct-martin left a comment

Choose a reason for hiding this comment

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

Approving under the assumption that @jibby0 's comment will be fixed

This commit is a first-pass explainer to what Matrix/Riot are and how we
use them in the FOSS@RIT community. It also collects some of the rooms I
know about but is probably not a complete list.

Closes #11.

Signed-off-by: Justin W. Flory <git@jwf.io>
@justjwheelin
Copy link
Member Author

Thanks everyone for the detailed reviews and feedback! 🎉 I am happy with the feedback collected so far, so I'm going to rebase and merge this PR. 🎬

@jibby0:
The IRC (Freenode) link under How we use Matrix (https://github.com/FOSSRIT/runbook/blob/master/docs/infra/irc) brings me to a 404

On GitHub.com this won't work, but when the docs are built and rendered on https://runbook.fossrit.community, this becomes an internal link to the IRC page. When I built them locally, it took me to the right place. 😄

@justjwheelin justjwheelin merged commit 9e81602 into master Feb 16, 2020
@justjwheelin justjwheelin deleted the add/matrix branch February 16, 2020 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs - infra Infrastructure, web services, and standard operating procedures new change Adds new capabilities or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document Matrix/Riot service
5 participants