Improving/extending Getting Started intro page #81
Conversation
| capabilities that are secure, easy to use and easy to self-host. | ||
|
|
||
| In plain simple words, Jitsi allows you to interact with other people though video and audio using your browser, your phone or a desktop app, and brings you all kind of related useful functionalities like text chat, screen sharing, and video recording. All of this wrapped in a friendly interface and without forgetting your security. |
There was a problem hiding this comment.
Thinking about it again, I would remove this section, it is unnecessary to advertise the software in the documentation, then again, for fairness, I have to say, that @saghul (one of the team members) had a different oppinion on that.
I would rewrite this:
- People should know what video conferencing is, so there is no need to explain it.
- Instead you can describe that Jitsi can be used in browsers and via apps.
Then you could point to additional features like you already mentioned:text chat, screen sharing, and video recording.
| ## About this handbook | ||
|
|
||
| This handbook aims to be the one-stop-shop for all Jitsi documentation. | ||
| This handbook aims to be the one-stop-shop for all Jitsi documentation. |
There was a problem hiding this comment.
Suggestion: This handbook is aimed to contain all Jitsi documentation.
| This handbook aims to be the one-stop-shop for all Jitsi documentation. | ||
| This handbook aims to be the one-stop-shop for all Jitsi documentation. | ||
|
|
||
| Whether you are a developer seeking to integrate Jitsi in one of your apps, a more experienced user looking for a specific configuration setup, or even if you are newcomer and have not experience with Jitsi at all, this Handbook will try to help you get there. |
There was a problem hiding this comment.
This can be removed imo, it is a too long introduction.
|
|
||
| Whether you are a developer seeking to integrate Jitsi in one of your apps, a more experienced user looking for a specific configuration setup, or even if you are newcomer and have not experience with Jitsi at all, this Handbook will try to help you get there. | ||
|
|
||
| :::note this is a work in progress. |
There was a problem hiding this comment.
I would write something like this:
:::note This handbook is work in progress.
(clarifies that it is about the handbook)
Some topics and sections are unfinished and others can be outdated.
If you want to help, you can either report mistakes or ideas via opening an Issue report on Github, or contribute directly by creating a Pull request.
(instructions how to edit the handbook should be given in the README.md on Github, then we should link to that.
Sadly right now the instructions are a bit unfinished.)
| If you want to help out please create a **Pull Request** in our [Github Repo](https://github.com/jitsi/handbook)! | ||
| - If you want to help out please consider creating a **Pull Request** in our [Github Repo](https://github.com/jitsi/handbook). No contribution is small! | ||
|
|
||
| - Not found what you wanted? Post your question in the [Jitsi Comunity Forums](https://community.jitsi.org/). |
There was a problem hiding this comment.
Very good point 👍.
But maybe this should be at the end of the text 🤔.
| @@ -5,25 +5,37 @@ title: Introduction | |||
|
|
|||
| ## What is Jitsi? | |||
|
|
|||
| Jitsi is a [collection of Open Source projects](architecture.md) which provide state-of-the-art video conferencing | |||
| Welcome to Jitsi! A [collection of Open Source projects](architecture.md) which provide state-of-the-art video conferencing | |||
There was a problem hiding this comment.
I would remove the "welcome", because the users are already greeted on the front page: https://jitsi.github.io/handbook/
So the sentence should still begin like before: Jitsi is a...
| ::: | ||
|
|
||
| The content is divided in 3 main areas: | ||
| That being said... lets go! |
There was a problem hiding this comment.
To be honest, I am biased because I wrote the sentence The content is divided in 3 main areas:,
but still I think it should be kept this short.
People know that the next part after this is a description of sections, so no need for long words imo.
|
|
||
| The content is divided in self descriptive sections. Depending of your needs you should start exploring the parts you feel will help you the most. But just in case you don't know where to start, here's a clue of what each topic is about. | ||
|
|
||
| * [The User guide](user-guide/user-guide.md). Designed for helping users to better |
There was a problem hiding this comment.
I was never a big fan of the long descriptions, maybe we could shorten this, like:
User Guide: Gives you information how to use Jitsi in your Browser or on your Smartphone.
It also gives an overview of available features and options.
Maybe we should add that it is largely unfinished for now 🤔.
| * [Developer guide](dev-guide/dev-guide.md): Designed to help developers who want to either | ||
| integrate the Jitsi Meet API / SDK in their products or want to improve Jitsi Meet | ||
| itself by developing new features or fixing bugs. | ||
| * [Self-Hosting guide](devops-guide/devops-guide.md): The place for folks wanting to self-host their own Jitsi service. If you are a system administrator who wants to learn how to deploy, operate and scale Jitsi properly, this is the section you must check out first. |
There was a problem hiding this comment.
I would also shorten it to:
Self-Hosting Guide: Contains information on how to set up your own Jitsi Server and additional configuration options as well.
|
|
||
| * [Self-Hosting guide](devops-guide/devops-guide.md): Designed for folks wanting to self-host, system administrators | ||
| or anyone who wishes to deploy and operate their own Jitsi Meet instance. | ||
| Anyway... if all of this sounds interesting to you and you just can't decide. Keep reading next section! |
There was a problem hiding this comment.
Maybe an unneccessary sentence.
Extending the intro page of the Getting Started section. First of some contributions I wanna pull in order to: