mirror of
https://github.com/element-hq/element-android
synced 2024-11-23 18:05:36 +03:00
Setup knit TOC.
Only ## and more heading will be listed, so add a "h" level.
This commit is contained in:
parent
3d437f94f1
commit
bc7a50124f
11 changed files with 42 additions and 9 deletions
|
@ -1,5 +1,8 @@
|
||||||
# Adding and removing ThreePids to an account
|
# Adding and removing ThreePids to an account
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Add email
|
## Add email
|
||||||
|
|
||||||
### User enter the email
|
### User enter the email
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Analytics in Element
|
# Analytics in Element
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Solution
|
## Solution
|
||||||
|
|
||||||
Element is using PostHog to send analytics event.
|
Element is using PostHog to send analytics event.
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Color migration
|
# Color migration
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
### Changes
|
### Changes
|
||||||
|
|
||||||
- use colors defined in https://www.figma.com/file/X4XTH9iS2KGJ2wFKDqkyed/Compound?node-id=557%3A0
|
- use colors defined in https://www.figma.com/file/X4XTH9iS2KGJ2wFKDqkyed/Compound?node-id=557%3A0
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Element Android design
|
# Element Android design
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Design at element.io is done using Figma - https://www.figma.com
|
Design at element.io is done using Figma - https://www.figma.com
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Identity server
|
# Identity server
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
Issue: #607
|
Issue: #607
|
||||||
PR: #1354
|
PR: #1354
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Integration tests
|
# Integration tests
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
Integration tests are useful to ensure that the code works well for any use cases.
|
Integration tests are useful to ensure that the code works well for any use cases.
|
||||||
|
|
||||||
They can also be used as sample on how to use the Matrix SDK.
|
They can also be used as sample on how to use the Matrix SDK.
|
||||||
|
|
|
@ -1,20 +1,23 @@
|
||||||
# Jitsi in Element Android
|
# Jitsi in Element Android
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
Native Jitsi support has been added to Element Android by the PR [#1914](https://github.com/vector-im/element-android/pull/1914). The description of the PR contains some documentation about the behaviour in each possible room configuration.
|
Native Jitsi support has been added to Element Android by the PR [#1914](https://github.com/vector-im/element-android/pull/1914). The description of the PR contains some documentation about the behaviour in each possible room configuration.
|
||||||
|
|
||||||
Also, ensure to have a look on [the documentation from Element Web](https://github.com/vector-im/element-web/blob/develop/docs/jitsi.md)
|
Also, ensure to have a look on [the documentation from Element Web](https://github.com/vector-im/element-web/blob/develop/docs/jitsi.md)
|
||||||
|
|
||||||
The official documentation about how to integrate the Jitsi SDK in an Android app is available here: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk.
|
The official documentation about how to integrate the Jitsi SDK in an Android app is available here: https://jitsi.github.io/handbook/docs/dev-guide/dev-guide-android-sdk.
|
||||||
|
|
||||||
# Native Jitsi SDK
|
## Native Jitsi SDK
|
||||||
|
|
||||||
The Jitsi SDK is built by ourselves with the flag LIBRE_BUILD, to be able to be integrated on the F-Droid version of Element Android.
|
The Jitsi SDK is built by ourselves with the flag LIBRE_BUILD, to be able to be integrated on the F-Droid version of Element Android.
|
||||||
|
|
||||||
The generated maven repository is then host in the project https://github.com/vector-im/jitsi_libre_maven
|
The generated maven repository is then host in the project https://github.com/vector-im/jitsi_libre_maven
|
||||||
|
|
||||||
## How to build the Jitsi Meet SDK
|
### How to build the Jitsi Meet SDK
|
||||||
|
|
||||||
### Jitsi version
|
#### Jitsi version
|
||||||
|
|
||||||
Update the script `./tools/jitsi/build_jisti_libs.sh` with the tag of the project `https://github.com/jitsi/jitsi-meet`.
|
Update the script `./tools/jitsi/build_jisti_libs.sh` with the tag of the project `https://github.com/jitsi/jitsi-meet`.
|
||||||
|
|
||||||
|
@ -22,7 +25,7 @@ Latest tag can be found from this page: https://github.com/jitsi/jitsi-meet-rele
|
||||||
|
|
||||||
Currently we are building the version with the tag `android-sdk-3.10.0`.
|
Currently we are building the version with the tag `android-sdk-3.10.0`.
|
||||||
|
|
||||||
### Run the build script
|
#### Run the build script
|
||||||
|
|
||||||
At the root of the Element Android, run the following script:
|
At the root of the Element Android, run the following script:
|
||||||
|
|
||||||
|
@ -32,7 +35,7 @@ At the root of the Element Android, run the following script:
|
||||||
|
|
||||||
It will build the Jitsi Meet Android library and put every generated files in the folder `/tmp/jitsi`
|
It will build the Jitsi Meet Android library and put every generated files in the folder `/tmp/jitsi`
|
||||||
|
|
||||||
### Link with the new generated library
|
#### Link with the new generated library
|
||||||
|
|
||||||
- Update the file `./build.gradle` to use the previously created local Maven repository. Currently we have this line:
|
- Update the file `./build.gradle` to use the previously created local Maven repository. Currently we have this line:
|
||||||
|
|
||||||
|
@ -57,7 +60,7 @@ implementation('com.facebook.react:react-native-webrtc:1.92.1-jitsi-9093212@aar'
|
||||||
- Perform a gradle sync and build the project
|
- Perform a gradle sync and build the project
|
||||||
- Perform test
|
- Perform test
|
||||||
|
|
||||||
### Sanity tests
|
#### Sanity tests
|
||||||
|
|
||||||
In order to validate that the upgrade of the Jitsi and WebRTC dependency does not break anything, the following sanity tests have to be performed, using two devices:
|
In order to validate that the upgrade of the Jitsi and WebRTC dependency does not break anything, the following sanity tests have to be performed, using two devices:
|
||||||
- Make 1-1 audio call (so using WebRTC)
|
- Make 1-1 audio call (so using WebRTC)
|
||||||
|
@ -65,7 +68,7 @@ In order to validate that the upgrade of the Jitsi and WebRTC dependency does no
|
||||||
- Create and join a conference call with audio only (so using Jitsi library). Leave the conference. Join it again.
|
- Create and join a conference call with audio only (so using Jitsi library). Leave the conference. Join it again.
|
||||||
- Create and join a conference call with audio and video (so using Jitsi library) Leave the conference. Join it again.
|
- Create and join a conference call with audio and video (so using Jitsi library) Leave the conference. Join it again.
|
||||||
|
|
||||||
### Export the build library
|
#### Export the build library
|
||||||
|
|
||||||
If all the tests are passed, you can export the generated Jitsi library to our Maven repository.
|
If all the tests are passed, you can export the generated Jitsi library to our Maven repository.
|
||||||
|
|
||||||
|
@ -81,4 +84,4 @@ url "https://github.com/vector-im/jitsi_libre_maven/raw/master/android-sdk-3.10.
|
||||||
|
|
||||||
- Build the project and perform the sanity tests again.
|
- Build the project and perform the sanity tests again.
|
||||||
|
|
||||||
- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android.
|
- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android.
|
||||||
|
|
|
@ -1,5 +1,8 @@
|
||||||
# Pull requests
|
# Pull requests
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
This document gives some clue about how to efficiently manage Pull Requests (PR). This document is a first draft and may be improved later.
|
This document gives some clue about how to efficiently manage Pull Requests (PR). This document is a first draft and may be improved later.
|
||||||
|
|
|
@ -2,6 +2,9 @@
|
||||||
|
|
||||||
This document describes the flow of signin to a homeserver, and also the flow when user want to reset his password. Examples come from the `matrix.org` homeserver.
|
This document describes the flow of signin to a homeserver, and also the flow when user want to reset his password. Examples come from the `matrix.org` homeserver.
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Sign in flows
|
## Sign in flows
|
||||||
|
|
||||||
### Get the flow
|
### Get the flow
|
||||||
|
@ -322,4 +325,4 @@ curl -X POST --data $'{"auth":{"type":"m.login.email.identity","threepid_creds":
|
||||||
{}
|
{}
|
||||||
```
|
```
|
||||||
|
|
||||||
The password has been changed, and all the existing token are invalidated. User can now login with the new password.
|
The password has been changed, and all the existing token are invalidated. User can now login with the new password.
|
||||||
|
|
|
@ -4,6 +4,9 @@ This document describes the flow of registration to a homeserver. Examples come
|
||||||
|
|
||||||
*Ref*: https://matrix.org/docs/spec/client_server/latest#account-registration-and-management
|
*Ref*: https://matrix.org/docs/spec/client_server/latest#account-registration-and-management
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Sign up flows
|
## Sign up flows
|
||||||
|
|
||||||
### First step
|
### First step
|
||||||
|
|
|
@ -10,6 +10,9 @@ Currently the test are covering a small set of application flows:
|
||||||
- Self verification via emoji
|
- Self verification via emoji
|
||||||
- Self verification via passphrase
|
- Self verification via passphrase
|
||||||
|
|
||||||
|
<!--- TOC -->
|
||||||
|
<!--- END -->
|
||||||
|
|
||||||
## Prerequisites:
|
## Prerequisites:
|
||||||
|
|
||||||
Out of the box, the tests use one of the homeservers (located at http://localhost:8080) of the "Demo Federation of Homeservers" (https://github.com/matrix-org/synapse#running-a-demo-federation-of-synapses).
|
Out of the box, the tests use one of the homeservers (located at http://localhost:8080) of the "Demo Federation of Homeservers" (https://github.com/matrix-org/synapse#running-a-demo-federation-of-synapses).
|
||||||
|
|
Loading…
Reference in a new issue