matrix community documentation

[knarrff]

• create and for development use feature branch: 259-matrix-community-documentation

• add place for future documentation

• link to there from separate places
  All mentions of chat in the sources:

  • https://github.com/DE-RSE/de-rse.github.io/blob/259-matrix-community-documentation/_posts/2019-10-22-frauen-in-derse.md
  • https://github.com/DE-RSE/de-rse.github.io/blob/259-matrix-community-documentation/_posts/2020-09-22-deRSE-MV.md
  • https://github.com/DE-RSE/de-rse.github.io/blob/259-matrix-community-documentation/_posts/2021-08-10-rse-gruppentreffen.md
  • https://github.com/DE-RSE/de-rse.github.io/blob/259-matrix-community-documentation/de/join.md
  • https://github.com/DE-RSE/de-rse.github.io/blob/259-matrix-community-documentation/en/join.md

• write documentation itself - feel free to copy/externally link, but keep a few things local

  • summary of connection information (main room directory with room links)
    Which is ROOMLINK HERE
  • introduction to matrix as a chat platform
  • general recommendations
    • for room settings
    • for client software for different platforms

• Add instructions on how to introduce yourself (website and channel description) (text from @ClaireWyatt)

• Add CoC (text from @ClaireWyatt)

• Add link to moderator team email address

• Publish documentation

[fiveop]

@knarrff could you add the room link to the description of the issue?

[knarrff]

@ClaireWyatt: do you already have a space and rooms created?

[fiveop]

What do you mean by room settings, @knarrff ? What should we document, that is relevant to a normal user?

[knarrff]

People will start creating rooms within the space. Those (public) rooms should have some common settings. For instance, some users should likely be made admin, so that a space owner can maintain the rooms within the space. Likely we want some 'admin functional account' for that. Also, these are settings like to make history available for people that newly join, a room logo, likely also other settings: things that non-admins can easily follow (check off a todo list) to distribute the work from space admins a little.

[knarrff]

Some of these setting ideas likely also come from @ClaireWyatt and @caha42.

[knarrff]

• need a bot that notifies the moderator team of joining people

[knarrff]

email lists:

• community-support
• matrix-support

[ClaireWyatt]

@fiveop @knarrff I'm writing a CoC today and that should be ready to review tomorrow. Also, I remember I asked if it would be possible to be notified when a person joins matrix so I can follow up with a welcome message. is this possible?

[ClaireWyatt]

@fiveop I think it would be useful if we put some instructions on how to put it on your phone? my colleague and I are trying to add the app and space to our phones ready for the conference and we can't make it work.

[fiveop]

Isn’t that covered with “We recommend to use the Element client for all major platforms.”?

[caha42]

Technical yes, practical most people will think OS for PCs not mobiles. But we could easily extend that sentence to "..for all major computer and mobile platforms".

[fiveop]

I changed the text according to the suggestion.

[ClaireWyatt]

@fiveop Could you add something about privacy to alleviate anyone's concerns?

and add the email addresses that Frank set up plus a short note next to each of what each can be used for.
a. [email protected]- if you would like help getting onto matrix or questions about how matrix works.
b. [email protected] - If you have a general request, comment or suggestion about the deRSE Community.

I think this is what we discussed about the two email addresses. But anyone amend if you think I've forgotten something.

[ClaireWyatt]

@fiveop @knarrff @caha42 here is the Code of Conduct, borrowed heavily from the Society - please have a review of it and suggest edits or additions - https://docs.google.com/document/d/1sOR5MZhYPJtIg1GueMcIWpxxF8x45GjHURyQ9OFPIQU/edit?usp=sharing

Apologies for such a late request to review but hopefully we can have this up on matrix and the deRSE website by Tuesday am.

[fiveop]

@fiveop Could you add something about privacy to alleviate anyone's concerns?

and add the email addresses that Frank set up plus a short note next to each of what each can be used for. a. [email protected]- if you would like help getting onto matrix or questions about how matrix works. b. [email protected] - If you have a general request, comment or suggestion about the deRSE Community.

I think this is what we discussed about the two email addresses. But anyone amend if you think I've forgotten something.

I added a section on getting support for matrix. Shouldn‘t the second email address be mentioned on some more general community page, for example https://de-rse.org/en/join.html ?

[fiveop]

@fiveop @knarrff @caha42 here is the Code of Conduct, borrowed heavily from the Society - please have a review of it and suggest edits or additions - https://docs.google.com/document/d/1sOR5MZhYPJtIg1GueMcIWpxxF8x45GjHURyQ9OFPIQU/edit?usp=sharing

Apologies for such a late request to review but hopefully we can have this up on matrix and the deRSE website by Tuesday am.

I went through it once (see anonymous remarks from just after 10am CET today). We should also have a German version of the text, once it is finalized.

This should also be a separate page on the website, with the matrix documentation referencing it.

[ClaireWyatt]

@fiveop Yes the community email address should be on that general page most likely.

[ClaireWyatt]

@fiveop Thanks for reviewing the Code of Conduct. I've incorporated your suggestions.

@caha42 @knarrff Would you have time to look at this before Monday evening?

@fiveop Are we ready to put the matrix documentation onto the website then?

[ClaireWyatt]

I'm just adding a german version. Please do go through and amend directly (without suggesting). It is translated by deeply.

[ClaireWyatt]

@fiveop Could you change this in the documentation to
'Tell us your name, where you live, where you work, what kind of RSE work you do and about your hopes and dreams for the deRSE community. '

to match the channel description.

[ClaireWyatt]

@fiveop In this sentence
'Once all the requirements are fulfilled please contact [email protected] to request addition of the room to the de-RSE space.'

we need to add the support email address please

[fiveop]

@fiveop Are we ready to put the matrix documentation onto the website then?

All we need to do is merge the branch and it is online.

[fiveop]

@fiveop Yes the community email address should be on that general page most likely.

I created a separate issue (#266) for this.

[ClaireWyatt]

@fiveop after this line on the matrix documention 'On this page, we document how you can find our rooms and give a few pointers to get you started using Matrix chat, in case you are new to the ecosystem.'

Could you add:
'We have a code of conduct for all the members on the matrix space which can be found here and we encourage everyone to read it.' (with a link to the CoC on the derse website.

[ClaireWyatt]

@fiveop if there are no further comments on the CoC, either english or German then I guess it can go on the deRSE website too.
https://docs.google.com/document/d/1sOR5MZhYPJtIg1GueMcIWpxxF8x45GjHURyQ9OFPIQU/edit#heading=h.b6cvqnf8hat4

[ClaireWyatt]

@fiveop
This sentence needs to be amended please 'The room should have logo. If there is no more suitable option, feel free to use the [de-RSE logo]({{ "/assets/img/matrix/derse-matrix-log.png" | prepend: site.baseurl }}). '

'The room should have a logo. If you don't have one, feel free to use 'deRSE logo''

[ClaireWyatt]

@fiveop I don't understand what this sentence means or what I'm supposed to do:

'The functional account @[email protected] must be added with the admin role.'

Could you expand on it a little?

[ClaireWyatt]

@fiveop Could you also change the first line please? and I've also added something about using your real name, 'first name, last name' when joining the space? Some people aren't using their names and this isn't some anonymous online forum.

'We, the de-RSE association and its surrounding community, use Matrix for our online community to enable us to bring together people doing Research Software Engineering across Germany. This online community is provided to encourage networking, sharing good practice and advertising events and jobs. We ask that you use your real 'First name, last name' when joining the space. '

[caha42]

@caha42 @knarrff Would you have time to look at this before Monday evening?

I'll try, but I am on the train and the internet is really shitty... -.-