Conversation
8d3cd39 to
977ae46
Compare
977ae46 to
7854fd7
Compare
Looks good to me! There's a few small things I might change/add. (None of very high importance, though)
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 |
Changing some wording, updating the screenshot. Signed-off-by: Justin W. Flory <git@jwf.io>
|
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. |
fd891c6 to
f26e0e7
Compare
ct-martin
left a comment
There was a problem hiding this comment.
@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
Added some frequently-referenced links for using Matrix. Signed-off-by: Justin W. Flory <git@jwf.io>
|
Thanks @ct-martin, I addressed your feedback in commit 99d8842. 👍 |
99d8842 to
a9c2ccb
Compare
|
@alch-emi what do you mean, legacy Riot client? |
jibby0
left a comment
There was a problem hiding this comment.
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 :)
a9c2ccb to
c6f2619
Compare
|
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. 🎬
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. 😄 |
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. 👀