decred / dcrweb

Decred website code.
37 stars 76 forks source link

Create a landing page for new Matrix users #452

Closed noahpierau closed 5 years ago

noahpierau commented 5 years ago

Matrix is an open source communication platform that has gained popularity among Decred contractors. However, it is poorly understood by most new users. The idea is to create a landing page similar to slack.decred.org to educate people about this platform.

There are different ways to register on Matrix. The landing page should educate people about the pros and cons of registering on the Decred homeserver instead of the default Matrix homeserver. Some advantages: 1) you have a nice decred.org in your user ID. 2) if the Decred homeserver gets disconnected from other homeservers, its users will still be able to communicate with one another. 3) easier to find other Decred rooms and users. 4) you won't route through a machine controlled by a 3rd party. There is one big disadvantage: when the user gets logged out and tries to reconnect, they will wonder why their password is invalid (they need to set their homeserver to the correct one with each login). This section should include a registration link with the custom homeserver filled out: https://riot.im/app/#/register?hs_url=https://matrix.decred.org

There are also different ways of reaching the Decred rooms. We should link to a collection of different Matrix clients, so users can pick their favorite: https://matrix.org/docs/projects/try-matrix-now.html and https://matrix.org/docs/projects/clients-matrix

If users want to use an existing Matrix account, the landing page should point them to https://matrix.to/#/+decred:decred.org

degeri commented 5 years ago

Some links that can be used for login.

https://riot.im/app/#/login?hs_url=https://matrix.decred.org

https://matrix.to/#/+decred:decred.org?hs_url=https://matrix.decred.org (don't know if this is the correct way to use matrix links but it seems to work)

jrick commented 5 years ago

I believe some clarity is needed regarding point 4. Messages are shared between all homeservers of all participants in a room. If a room has participants from both matrix.org and decred.org, the messages will be shared across both instances. However, if another room only contains participants from decred.org, the messages are not shared to matrix.org because there is no need for that homeserver to be aware of these messages.

Direct messages are just a special case where a room has only two participants. If the two participants are on decred.org, the messages are not federated to any other homeserver.

End-to-end encryption is also available to use if you want to keep a chat private, and has obvious benefits even if both participants are already on the same homeserver. This encrypts and decrypts messages at the client endpoints instead of only the messages being TLS encrypted between clients and homeservers, and between two homeservers.

xaur commented 5 years ago

Something to consider about end-to-end encryption used in Matrix: it does not encrypt quite a lot of metadata: who talks to whom, when, in what room, maybe something else.

noahpierau commented 5 years ago

A while ago I created this image as a guide to sign up for Matrix:

image

It helped people to sign up "correctly" so maybe a similar guide can be included on the new page.

s-ben commented 5 years ago

@ZeroASIC and I were talking about collaborating on this. I would create some copy and he would work on a page for decred.org. @noahpierau , this image is really good. I'm wondering how we can reuse it. My concern now, upon reflection, is that a) detailed instructions may be too long to include on decred.org?, and that b) I know there's been a general redesign afoot, and Ditto is coming up with new messaging as we speak. I'm worried we will produce something that doesn't fit well into decred.org. Thoughts? I do think that it's worth creating a separate page for Matrix. Just wondering what form it should take. E.g. should we move the detailed signup instructions with screenshots to dcrdocs, and make the decred.org landing page more of a summary?

s-ben commented 5 years ago

@ZeroASIC , have taken a stab at copy for the landing page. I'm thinking we could do something similar to https://slack.decred.org/, but without the email registration field?

Join our Matrix community

Matrix is a secure, open messaging platform popular with Decred contractors. It allows users to communicate with other community members across other Decred channels, such as Slack, Telegram, and Discord, without leaving the Matrix chat client. Matrix requires only an email or phone number for registration.

To join Matrix, you’ll need to choose a client and a homeserver. Matrix supports numerous clients and homeservers, but for first-time users, we recommend the most well-supported Matrix client, Riot, and Decred’s homeserver. Using the Decred homeserver makes it easier to find Decred chat rooms, puts ‘decred.org’ in your ID, and allows you to continue messaging should Decred’s homeserver become disconnected with other homeservers.

To register using the Riot web app, with Decred’s homeserver information pre-filled, click the link below. https://riot.im/app/#/register?hs_url=https://matrix.decred.org

Note: you must register with an email address if you want password resets.

If you already have an existing Matrix account, use the link below to log into Decred’s homeserver. https://matrix.to/#/+decred:decred.org

To browse other available Matrix clients and home servers, see the Matrix Getting Started page, https://matrix.org/docs/projects/try-matrix-now.html

ZeroASIC commented 5 years ago

I started a draft for this in a new branch (https://github.com/ZeroASIC/dcrweb/tree/issue452)

I added two directories for the community landing pages, one for Matrix and an update for Slack because the menu was out of date. They're not link directly from the community page yet. The Matrix page is based on the existing layout for slack.decred.org so they share a background image.

noahpierau commented 5 years ago

Can you share a screenshot of the WIP?

ZeroASIC commented 5 years ago

screenshot_2018-12-11_16-40-29

noahpierau commented 5 years ago

Awesome, this is exactly what we need!

Really great job everyone, I think we should strive to publish this page ASAP.

ZeroASIC commented 5 years ago

If no one has any changes for it, I can update the Community page and do a Pull Request. Should I leave the /slack/index.html where it is or just delete it? All I did was update the menu and some paths.

s-ben commented 5 years ago

Looks good!

I would just make a couple suggestions.

ZeroASIC commented 5 years ago

screenshot_2018-12-11_22-29-15

ZeroASIC commented 5 years ago

Should I update the footer to match the rest of the site? I could either update both of them or leave this one as is.

Edit: I kind of like this one though. It's simple and not distracting. It fits the theme and purpose of the page.

s-ben commented 5 years ago

Maybe more of a call for @noahpierau or other design peeps, but I kinda like it as is. I searched a few other pages and it doesn't appear we're entirely consistent with the footer. Though whether this is by design or accident I'm not sure.

ZeroASIC commented 5 years ago

That's an accident. I thought I fixed that once, but I'm not the only one doing things. /press/ is a bit off. Other domains are completely different.

s-ben commented 5 years ago

It's like dcrdocs. An amorphous decentralized cloud of content morphing into something coherent.

jrick commented 5 years ago

There's still a giant slack logo in the background picture.

xaur commented 5 years ago

I worry that people will skip the text due to distracting background image. Personally I'm more likely to read simple black on white text.

xaur commented 5 years ago

Matrix is a secure

Too abstract, what do you mean by secure?

It allows users to communicate with other community members across other Decred channels, such as Slack, Telegram, and Discord, without leaving the Matrix chat client.

Bridge software allows it, not Matrix.

Matrix requires only an email or phone number for registration.

Email and phone are optional and this should be emphasized. This is a very cool and very rare feature on the web. You can choose to have a first party registration that doesn't involve any middlemen (email service). But users must be notified of pros and cons of setting or not setting an email.

ZeroASIC commented 5 years ago

I'd like to keep this page as similar to slack.decred.com as possible. Anything we change about the design should get propagated back to that page, which is why I made a copy of it in /slack/. I think what we really need is a short term solution and a long term plan. In the short term it doesn't need to be perfect, but it does need to be effective. Eventually we could make landing pages for all of the supported chat platforms.

ZeroASIC commented 5 years ago

Too abstract, what do you mean by secure?

There's some danger in providing too much information. I'm not usually in favor of bombarding website users with lots of technical information. That information usually belongs in a technical document, not the copy intended to bring users into the community. We could make an additional document to accompany this page in docs.decred.org (e.g. Matrix faq) and provide a link to it.

s-ben commented 5 years ago

Agree with @ZeroASIC on need for keeping web copy concise. @xaur , I was imagining your criticisms while I was writing copy, lol. I think the best solution would be to: 1) edit copy to incorporate xaur points (while keeping it high-level), 2) link to a separate page that provides more details on security, accompanied by a line like, "to read more about security details of Matrix, click here".

I'm tempted to create a page on dcrdocs on Matrix. However, I don't see a non-awkward place to put it. Creating a new page might require some restructuring of other pages/menu. That might be worth doing anyway, but it's something to consider. Is there an outside page we can link to that summarizes this info for users?

s-ben commented 5 years ago

Also, is there another image we can use that doesn't have the Slack logo? At the very least, if there's no other image handy (or Design can't be bothered), we could Photoshop out the '#' logo, maybe replace it with Matrix logo. Wouldn't take much time to do.

noahpierau commented 5 years ago

The way I look at it: the "logo" is really just a hash tag, which is used in Matrix as well.

Maybe we can link to the Matrix docs?

Agreed with updating the copy, and maybe editing in the Matrix logo, but IMO we shouldn't spend too much time on it. The most important thing is that we put it live. After that we can start iterating on it.

xaur commented 5 years ago

No need to bombard the user with any techincal details, I suggest to just remove the claim about security unless you can link to a page that explains why it is "secure".

ZeroASIC commented 5 years ago

No need to bombard the user with any techincal details, I suggest to just remove the claim about security unless you can link to a page that explains why it is "secure".

This is the official doc on encryption. We don't have to use it, I just wanted to point it out. https://matrix.org/docs/guides/faq#encryption

s-ben commented 5 years ago

Have updated the copy on the first paragraph to address concerns (below). I think it's OK to use "secure" in the first sentence as long as we provide a link to further details about security features.

"Matrix is a secure, open messaging platform popular with Decred contractors. It uses bridge technology to allow users to communicate with community members across other Decred channels such as Slack, Telegram and Discord, without leaving Matrix. Matrix offers first party registration; no identifying information or third party service is required to sign up. Users should be aware however that some features, such as password reset, do require an email address. For more on Matrix’s security features and available clients, see the Matrix project homepage."

@ZeroASIC, just saw your link to encryption. This link is good, though perhaps the link to the homepage is better, as a security-minded user will be motivated to find this link themselves, and other users may just want general info (like what other clients are available).

ZeroASIC commented 5 years ago

I removed the background image so we could compare it to the first draft. screenshot_2018-12-13_14-46-30

s-ben commented 5 years ago

Looks good!

image

Note: just now, GitHub just started giving me a vague error message when I tried to upload an image (something went wrong, try again?). After trying a few tries, I turned off Brave's tracking (Shields Down). Image uploaded fine...

image

xaur commented 5 years ago

If it's not too late I'd simplify 2nd sentence

With the help of bridge software Matrix users can communicate with users on other Decred platforms such as Slack and Discord.

Also dropped Telegram because it is no longer bridged.

ZeroASIC commented 5 years ago

I updated the second sentence, replaced the Roit.im link with Matrix on the community page. Is Rocket.Chat bridged? If not then I should move it on the community page.

ZeroASIC commented 5 years ago

screenshot_2018-12-14_15-21-59

ZeroASIC commented 5 years ago

I also updated the footer on the press page and in /slack/ because it was looking a little old. I still don't know if I'm keeping /slack/. I'd like to because slack.decred.org is looking pretty old and needs an update. If we could get it to run out of the /slack/ folder that would give us the ability to update it. Right now it's kind of orphaned.

xaur commented 5 years ago

@ZeroASIC there are talks to drop RocketChat because almost nobody uses it. I suggest to not mention it until we know for sure if it will stay or not.

ZeroASIC commented 5 years ago

@xaur That's fine, I wasn't going to change the copy. I'm just reordering the links on the community page. I think I'll put Rocket.Chat on the second row since it might get dropped.

ZeroASIC commented 5 years ago

I'm going to put the pull request in this afternoon. I think we've had enough iterations in development that I'm starting to get into the details more than I need to for an initial release. I can always update it again later.

ZeroASIC commented 5 years ago

Pull Request #462 is in.

ZeroASIC commented 5 years ago

Update with room directory instructions and link. screenshot_2019-01-03_15-23-39

s-ben commented 5 years ago

Having just the circular directory icon looks better than the screenshot I suppose, but it's still slightly awkward visually, and redundant if we're using the more descriptive text IMO. Maybe if we can make the circle fit better with text (smaller maybe?), we should keep it. But I would vote to just delete it and go with just text.

ZeroASIC commented 5 years ago

Works for me, just text then. Would a link to the directory listing be useful?

s-ben commented 5 years ago

Good idea, but I'm wondering if it will be a different link based on whether they choose the Decred custom homeserver or not, or if they use a different client. Could be multiple points of entry.

ZeroASIC commented 5 years ago

Yeah, the complication with this section is that we're favoring one configuration on one piece of software.

xaur commented 5 years ago

Link to directory listing: https://riot.im/app/#/directory but it indeed may show different results depending on homeserver.

A more stable link is Decred matrix community: https://riot.im/app/#/group/+decred:decred.org - it's missing couple rooms but that will be fixed eventually.

Re the round button, you can make a rectangular screenshot of the button panel with the two buttons highlighted.

s-ben commented 5 years ago

Just tested out the registration flow with a new phone number (FYI, Google Voice gives you a free number, though you have to verify it with a text to an existing number), used our registration link that auto-fills the Decred homeserver and suggested directory link above (https://riot.im/app/#/group/+decred:decred.org). It all worked good. Honestly, I think we're fine directing people towards Riot+homeserver+directory link. Matrix is not user friendly (yet). I definitely struggled with it. We should offer the easiest, safe path on. If someone is hardcore enough to want to choose different Matrix servers, etc., they're technically savvy enough not to need these high-level instructions. Let's ship this puppy!

noahpierau commented 5 years ago

The landing page is live, great work! https://www.decred.org/matrix/