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

Channels: your quick start guide #427

Merged
merged 9 commits into from
Feb 16, 2023

Conversation

jorge-campo
Copy link
Contributor

  • Rebase develop branch -- new file, index, urls-en.txt and mkdocs.yml
  • rebase develop branch - article and place holders
  • rebase develop branch - icons
  • fixing the text
  • fixing general channel info
  • rebase develop branch -- 287 rebase and update topic branch
  • 287 review and changes
  • 287 final review -- ready for publication

@jorge-campo jorge-campo added doc-new Additions to the Status documentation E:Communities Status Communities labels Feb 8, 2023
@jorge-campo jorge-campo self-assigned this Feb 8, 2023
@jorge-campo
Copy link
Contributor Author

Hey @Fabiomorais87 , this is my review of your initial draft. Because we deleted your original PR to update the icons, I can't send my updated version against your original one for comparison. Anyhow, here are my comments on your original version.

  • You're using standard Markdown links, which is not what we do. Please, use the correct [Text][link-to-doc] structure with the urls-en.txt document.

  • Status communities -> Status Communities. "Communites" goes uppercase 'C' when written next to Status because it's a product feature.

  • Avoid using Latin abbreviations like vs. -- This is described here: Common words usage.

  • Be careful with the Oxford comma; we don't use this (we used it initially, but the style guide was updated to reflect the change.)

  • I've rewritten your first paragraph. I don't entirely see your comparison with email.

  • In the intro, I included information about the two different types of channels and how the "Request to join" option affects both.

  • Under the "Channel information" header, you repeat the same information you used in the same paragraph. Repetition is good, but only for important information. This looks more like a filler, so I'm removing that.

  • When mentioning public/private and the lock icon, reuse the content you wrote in a different article.

  • "Click or tap :mobile-more-options: more options to view channel information." This "click" only applies to the desktop version. Use a different action verb that makes sense in mobile as well

  • Regarding your original text about censorship resistance. Be careful with concepts like censorship and privacy. Your admonition is mixing these two. On the one hand, you have "censorship-resistant," which means that Status doesn't use centralized servers, so Status (or governments) can't block the app. On the other hand, you have "privacy," which means communications are encrypted and only readable by the intended recipient. These two things are different: you can have one without the other.

  • Regarding the original "channel encryption" admonition. The existing "encryption" feature for Communities is visible during development but won't be visible later. Because this option won't appear in the UI, we should not mention that (it will confuse readers.) On that admonition, you only need to add that messages in channels use strong end-to-end encryption as part of the Status messaging stack.

  • I've spiced-up number format, using the Material for MkDocs built-in icons.

  • This is incorrect: "The #general channel is not created by default when you create a community." This channel exists in every community by default.

@earakel
Copy link
Contributor

earakel commented Feb 8, 2023

Hey @Fabiomorais87 and @jorge-campo, I'm barging in uninvited with a few wording suggestions! That's what I noticed as someone who's just read this article for the very first time, so maybe these will help simplify things a bit. Please feel free to ignore these if I'm interfering with some process.

  • 'When you join a community, you automatically have access to these channels'
    'get'?
  • 'This area shows the channel name and permissions'
    'You can see the channel name and permissions here'?
  • 'From this area, you can select more options :mobile-more-options: to access additional channel information, like channel members, permissions or notifications.'
    'such as'? I feel that 'like' is too informal for documentation.
  • 'The #general channel exists by default when you [create a community][create-a-status-community].'
    'appears' or 'is created'?
  • As a community administrator, you can use the following tips to make this channel more helpful:
    'here's how you can make this channel more helpful'?
  • [Set permissions][configure-channel-permissions] to restrict who can post in #general.
    'Set up'?

@jorge-campo
Copy link
Contributor Author

Thanks, @shamisem -- I will add your suggestions and merge the content.

@jorge-campo
Copy link
Contributor Author

Waiting for the screenshots to update and publish the topic.

@Fabiomorais87 Fabiomorais87 merged commit b2016be into develop Feb 16, 2023
@Fabiomorais87 Fabiomorais87 deleted the 287-review-channels-your-quick-start-guide branch February 16, 2023 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-new Additions to the Status documentation E:Communities Status Communities
Projects
Status: Published/Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants