From bc7a50124f2e3fb981c80abef33d7322b39da73f Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Mon, 30 May 2022 14:34:32 +0200 Subject: [PATCH] Setup knit TOC. Only ## and more heading will be listed, so add a "h" level. --- docs/add_threePids.md | 3 +++ docs/analytics.md | 3 +++ docs/color_migration_guide.md | 3 +++ docs/design.md | 3 +++ docs/identity_server.md | 3 +++ docs/integration_tests.md | 3 +++ docs/jitsi.md | 19 +++++++++++-------- docs/pull_request.md | 3 +++ docs/signin.md | 5 ++++- docs/signup.md | 3 +++ docs/ui-tests.md | 3 +++ 11 files changed, 42 insertions(+), 9 deletions(-) diff --git a/docs/add_threePids.md b/docs/add_threePids.md index 6fb0aff426..09eaa1e2ec 100644 --- a/docs/add_threePids.md +++ b/docs/add_threePids.md @@ -1,5 +1,8 @@ # Adding and removing ThreePids to an account + + + ## Add email ### User enter the email diff --git a/docs/analytics.md b/docs/analytics.md index 135ace81b0..0661abe721 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -1,5 +1,8 @@ # Analytics in Element + + + ## Solution Element is using PostHog to send analytics event. diff --git a/docs/color_migration_guide.md b/docs/color_migration_guide.md index 31a531d124..96f1606b49 100644 --- a/docs/color_migration_guide.md +++ b/docs/color_migration_guide.md @@ -1,5 +1,8 @@ # Color migration + + + ### Changes - use colors defined in https://www.figma.com/file/X4XTH9iS2KGJ2wFKDqkyed/Compound?node-id=557%3A0 diff --git a/docs/design.md b/docs/design.md index a79f19cf3e..4aeb9cd6a4 100644 --- a/docs/design.md +++ b/docs/design.md @@ -1,5 +1,8 @@ # Element Android design + + + ## Introduction Design at element.io is done using Figma - https://www.figma.com diff --git a/docs/identity_server.md b/docs/identity_server.md index e765ae3949..3397f89166 100644 --- a/docs/identity_server.md +++ b/docs/identity_server.md @@ -1,5 +1,8 @@ # Identity server + + + Issue: #607 PR: #1354 diff --git a/docs/integration_tests.md b/docs/integration_tests.md index e79f966d1f..dcf73faecd 100644 --- a/docs/integration_tests.md +++ b/docs/integration_tests.md @@ -1,5 +1,8 @@ # Integration tests + + + 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. diff --git a/docs/jitsi.md b/docs/jitsi.md index 1b4e0a37b4..ab3f880d4a 100644 --- a/docs/jitsi.md +++ b/docs/jitsi.md @@ -1,20 +1,23 @@ # Jitsi in Element Android + + + 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) 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 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`. @@ -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`. -### Run the build script +#### Run the build 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` -### 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: @@ -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 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: - 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 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. @@ -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. -- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android. \ No newline at end of file +- Update the file `/CHANGES.md` to notify about the library upgrade, and create a regular PR for project Element Android. diff --git a/docs/pull_request.md b/docs/pull_request.md index 94f8f3b6d8..88c7223886 100644 --- a/docs/pull_request.md +++ b/docs/pull_request.md @@ -1,5 +1,8 @@ # Pull requests + + + ## 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. diff --git a/docs/signin.md b/docs/signin.md index 0a234d2a20..fb8eefcc86 100644 --- a/docs/signin.md +++ b/docs/signin.md @@ -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. + + + ## Sign in flows ### 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. \ No newline at end of file +The password has been changed, and all the existing token are invalidated. User can now login with the new password. diff --git a/docs/signup.md b/docs/signup.md index 97cd20a423..3461c26b35 100644 --- a/docs/signup.md +++ b/docs/signup.md @@ -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 + + + ## Sign up flows ### First step diff --git a/docs/ui-tests.md b/docs/ui-tests.md index 667a6ed7fb..8c3aa01cfd 100644 --- a/docs/ui-tests.md +++ b/docs/ui-tests.md @@ -10,6 +10,9 @@ Currently the test are covering a small set of application flows: - Self verification via emoji - Self verification via passphrase + + + ## 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).