Commit graph

411 commits

Author SHA1 Message Date
Travis Ralston
1384783a77
Update SdkConfig usage to use new translation layer + update config.md docs (#21429)
* Update SdkConfig usage to use new translation layer

* Appease the linter

* WIP refactor of config documentation

* Finish re-writing config.md

* Update surrounding documentation

* Apply suggestions from code review

Co-authored-by: Germain <germains@element.io>

* Textual updates

Co-authored-by: Germain <germains@element.io>
2022-03-18 10:12:44 -06:00
Kerry
31702e9a26
add feature_location_share_live doc (#21339)
Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-07 13:49:24 +01:00
eleensmathew
43a55698e3
Added Threaded Messaging (#21303) 2022-03-04 08:26:58 +00:00
Michael Telatynski
240c3be014
Mandate use of js-sdk/src/matrix import over js-sdk/src (#21257) 2022-03-01 19:26:22 +00:00
Travis Ralston
087aed80dd
Add docs for custom_translations_url (#21188) 2022-03-01 11:53:12 -07:00
Travis Ralston
c13a1908df
Add docs for logout_redirect_url (#21222) 2022-03-01 11:06:15 -07:00
Kerry
de9e65de2b
labs doc for feature_location_share_pin_drop (#21242)
Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-03-01 10:50:20 +01:00
Travis Ralston
65adc3ba93
Add a config.json option to skip the built-in Jitsi welcome screen (#21190)
* Add a config.json option to skip the built-in Jitsi welcome screen

Stop-gap for https://github.com/vector-im/element-web/issues/20503

* Spelling
2022-02-28 11:02:03 -07:00
Travis Ralston
95de708f4e
Make customisations (and general file overrides) easier to specify (#21189)
Intended for customisation endpoints - see included docs.
2022-02-24 12:52:08 -07:00
Travis Ralston
a01684e126
Docs for labs flag: Show only current profiles (#21093) 2022-02-18 07:58:14 -07:00
Michael Telatynski
135f37eeaf
Deprecate Piwik/Matomo support (#21090) 2022-02-15 16:46:53 +00:00
Kerry
d4a019b27a
add ComponentVisibility to customisation docs (#21008)
* add componentvisibility to customisation md

Signed-off-by: Kerry Archibald <kerrya@element.io>

* few more words

Signed-off-by: Kerry Archibald <kerrya@element.io>
2022-02-09 17:21:54 +01:00
Faye Duxovni
64242a004e
Document uisi_autorageshake_app config option (#20845) 2022-02-03 10:50:18 -05:00
Andy Balaam
6bc7036dc8
Remove the Location Sharing labs feature (#20863) 2022-02-02 11:51:32 +00:00
Eric Eastwood
d731a25619
Document jump to date labs feature (MSC3030) (#20825)
Feature added in:

 - https://github.com/matrix-org/matrix-react-sdk/pull/7339
 - https://github.com/matrix-org/matrix-react-sdk/pull/7372
 - MSC3030: https://github.com/matrix-org/matrix-doc/pull/303
2022-01-31 17:32:44 -06:00
Travis Ralston
7078373fbb
Support a config option to change the default device name (#20790) 2022-01-28 08:52:43 -07:00
Andy Balaam
cfa97212f7
Document use of .well-known for tile server and jitsi (#20734) 2022-01-27 09:44:59 +00:00
David Baker
433542010b
Update jitsi doc to specify minimum version (#20737)
and also rephrase a bit I was failing to understand
2022-01-25 14:42:02 +00:00
Michael Telatynski
397e2b53d1
De-labs Metaspaces (#20706) 2022-01-25 12:42:09 +00:00
Michael Telatynski
e0353b217c
De-labs Message Bubbles layout (#20705) 2022-01-25 10:12:02 +00:00
J. Ryan Stinnett
6adaa417f0
Add labs docs for right panel default open (#20722) 2022-01-24 17:53:46 +00:00
Andy Balaam
06fa4f4440
New config for maps (#20668) 2022-01-21 14:34:47 +00:00
Andy Balaam
c40dbf1580
Remove the documentation of the Polls labs feature (#20639) 2022-01-20 09:41:00 +00:00
Travis Ralston
9c4d57e91c
Documentation for extensible events labs flag (#20405)
* Documentation for extensible events labs flag

* Fix git protocol usage

Prevents this:
```
+ git clone git://github.com/matrix-org/matrix-js-sdk.git matrix-js-sdk --branch develop --depth 1
Cloning into 'matrix-js-sdk'...
fatal: remote error:
  The unauthenticated git protocol on port 9418 is no longer supported.
Please see https://github.blog/2021-09-01-improving-git-protocol-security-github/ for more information.
```
2022-01-13 09:56:38 -07:00
Michael Telatynski
d7813c09d9
Update default Jitsi URLs to meet.element.io (#20487) 2022-01-11 16:15:17 +00:00
Timo
27ad1ebda0
Remove maximised widget feature docs (#20481) 2022-01-11 12:23:32 +00:00
Kerry
30cb0ae96d
add docs for UIFeature.TimelineEnableRelativeDates (#20251)
Signed-off-by: Kerry Archibald <kerrya@element.io>
2021-12-21 10:08:35 +01:00
Michael Telatynski
1d7c4d5d92
Document feature_spotlight (#19699) 2021-12-10 09:18:22 +00:00
Matthew Hodgson
9b780e0e60
Simple static location sharing (#19754)
Adds static location share a la [MSC3488](https://github.com/matrix-org/matrix-doc/pull/3488) behind a labs flag, supporting legacy `m.location` `msgtype` too.  Powered by https://github.com/matrix-org/matrix-react-sdk/pull/7135.  Adds maplibre as a dependency.

To make this work, you have to add a valid `map_style_url` to your config.json.
2021-12-06 10:11:06 +00:00
James Salter
95a2b8eb2f
Remove feature_pseudonymous_analytics_opt_in (#19900)
Depends on https://github.com/matrix-org/matrix-react-sdk/pull/6936/
2021-12-06 00:49:08 +00:00
James Salter
317430b6b1
Add analyticsOwner (#19401) 2021-12-06 11:42:19 +11:00
Michael Telatynski
2039f1fcae
Document feature_breadcrumbs_v2 (#19700) 2021-12-01 10:50:08 +00:00
Michael Telatynski
8e58d31db3
Document feature_spaces_metaspaces (#19679)
Co-authored-by: Jonathan de Jong <jonathandejong02@gmail.com>
2021-11-11 13:07:47 +00:00
Timo
3d2880ddfb
Add docs for maximised widgets labs feature (#19628)
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-11-05 11:43:43 +00:00
Travis Ralston
004e8edcb2
Deprecate sso_immediate_redirect and add welcome-page only option (#19437)
* Deprecate `sso_immediate_redirect` and add welcome-page only option

The old `sso_immediate_redirect` option is kept in code for backwards compatibility, but is replaced by `sso_redirect_options.immediate`, where a new `on_welcome_page` option is also introduced to only target entry points to the app. 

The path matching is a bit brittle, but still ideal in the sense of not showing UI while the app realizes it needs to redirect.

The new welcome page-only option is fully intended to avoid breaking permalinks and such while still redirecting when needed. In future, other options might be added here to further tune the experience.

* Add note about guests
2021-10-21 08:35:05 -06:00
Travis Ralston
c405880a39 Add labs docs for polls feature
See https://github.com/matrix-org/matrix-react-sdk/pull/6934
2021-10-12 15:15:17 -06:00
Maximilian Kratz
0142bb04e4 Removed iOS Jitsi notice 2021-09-30 13:50:43 +02:00
Dariusz Niemczyk
79c4b95824
Fix link to README in translation-docs again 2021-09-17 13:19:38 +02:00
Dariusz Niemczyk
1dcdd549d0
Fix broken readme link 2021-09-17 12:58:19 +02:00
Michael Telatynski
1d5d7751f7 Merge branch 'develop' of github.com:vector-im/element-web into t3chguy/fix/18088 2021-09-08 15:29:11 +01:00
James Salter
e88948917a
Update labs.md 2021-09-03 08:41:09 +01:00
Paulo Pinto
c103565b3c Document feature_new_layout_switcher
Signed-off-by: Paulo Pinto <paulo.pinto@automattic.com>
2021-09-02 16:26:26 +01:00
David Baker
d294c9087f
Merge pull request #18697 from vector-im/dbkr/update_pr_previews_doc
Update PR previews doc post GHA
2021-08-24 11:29:11 +01:00
David Baker
aea3b67896 Update PR previews doc post GHA
It's not in the checks section anymore.
2021-08-23 17:14:49 +01:00
James Salter
931ac30f6b
Documentation for sentry config
Documents keys added in https://github.com/matrix-org/matrix-react-sdk/pull/6597
2021-08-18 09:01:29 +01:00
Michael Telatynski
55338701ea Delabs Spaces, keeping it as a default-on preference for the time being 2021-08-11 14:52:43 +01:00
Šimon Brandner
d5cd770c84
Add docs for feature_hidden_read_receipts
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
2021-08-06 07:58:33 +02:00
James Salter
79157c0bf9
Add config keys for posthog 2021-08-04 10:32:45 +01:00
Travis Ralston
858d71218c Remove voice messages labs flag docs
For https://github.com/matrix-org/matrix-react-sdk/pull/6437
2021-07-21 18:11:06 -06:00
Libexus
bf88906de8 Add the Matrix Space to the translations guide 2021-07-20 16:18:33 +02:00
David Teller
92ae57df3f Labs: feature_report_to_moderators
Signed-off-by: David Teller <davidt@element.io>
2021-06-18 18:07:16 +02:00
Robin Townsend
4e1204f34e Remove logo spinner
Removed since design wants to avoid associating slowness with the brand.

Signed-off-by: Robin Townsend <robin@robin.town>
2021-05-20 17:28:25 -04:00
Travis Ralston
45424f4a3b Better words? 2021-05-10 19:03:57 -06:00
Travis Ralston
c246d7839f Remove "in development" flag from voice messages labs documentation
See https://github.com/matrix-org/matrix-react-sdk/pull/5995
2021-05-07 19:37:40 -06:00
David Baker
c5f533011b
Merge pull request #17008 from vector-im/dbkr/asserted_identity
Document option for obeying asserted identity
2021-04-28 09:47:50 +01:00
David Baker
d03032b808 Put asserted identity under voip section 2021-04-27 19:34:21 +01:00
J. Ryan Stinnett
f0069c6ebd
Merge pull request #16980 from vector-im/jryans/code-quality
Add code quality review policy
2021-04-23 18:11:22 +01:00
J. Ryan Stinnett
15fe7091ff Add section on quality when guarded by a feature flag 2021-04-23 17:46:08 +01:00
David Baker
c98ca42bbd Document option for obeying asserted identity 2021-04-19 20:31:55 +01:00
J. Ryan Stinnett
b0c43890af Change #element-dev reference to a link 2021-04-19 17:02:11 +01:00
J. Ryan Stinnett
c2e87dde85 Add code quality review policy
This adds a new review policy which encourages tests for new features. As with
everything, we'll continue to tune this based on feedback.
2021-04-16 18:53:18 +01:00
J. Ryan Stinnett
001b15b856 Rewrap review guide 2021-04-16 16:02:46 +01:00
Travis Ralston
4c96b7826c Labs documentation for DND mode 2021-04-15 00:50:35 -06:00
Travis Ralston
1de7828e4d Write out docs explicitly. 2021-04-12 14:59:56 -06:00
Travis Ralston
c580148bb7 Add mobile download link configuration
This is similar to the desktopBuilds config option.

The mobile setup guide and static incompatible browser pages are not touched by these options given they are static assets and easily replaced.
2021-04-08 18:39:09 -06:00
Travis Ralston
97a43d058d Support a config option to skip login/welcome and go to SSO
For deployments which want this sort of functionality for their users. Ideal for self-hosted deployments.
2021-04-06 19:39:26 -06:00
Germain
a9db513352
Update docs/native-node-modules.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-03-29 18:07:45 +01:00
Germain Souquet
1ea1d29d3e Move native node modules documentation to element-desktop 2021-03-29 15:59:21 +01:00
J. Ryan Stinnett
57d5206592
Merge pull request #16447 from nielsbasjes/AddK8sExampleConfig
Add example for deployment into Kubernetes
2021-03-25 13:18:14 +00:00
Travis Ralston
6201c3a3f5
Merge pull request #16705 from vector-im/travis/voice-messages/exp
Add webpack config and labs flag docs for voice messages
2021-03-24 09:56:39 -06:00
Niels Basjes
281236432a Provide documentation on how to run on Kubernetes 2021-03-23 11:55:11 +01:00
Travis Ralston
a1c602c98e
Merge pull request #16468 from vector-im/travis/welcome-login
Docs for `loginForWelcome`
2021-03-19 09:12:42 -06:00
Travis Ralston
146ed151dd Add docs for labs flag 2021-03-16 23:24:26 -06:00
Travis Ralston
e2ce4239bd Improve docs for customisations
The new regex considers Windows as an OS, and the added array helps reduce merge conflicts for the future.
2021-03-09 14:17:51 -07:00
J. Ryan Stinnett
134618f4cd Remove old conferencing doc
This old document from 2015 has no connection to the current state of
conferencing, so best to remove it to avoid confusion.
2021-03-09 13:23:18 +00:00
David Baker
b910fcd38a Add option for audio live streaming
Starts jitsi streaming to a specially configured URL so that the
jitsi server can start an audio-only stream, in combination with an
API to manage audio streams by room ID.
2021-03-04 18:00:55 +00:00
Michael Telatynski
f0a8f166c9
Update docs/labs.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-02-25 15:38:28 +00:00
Michael Telatynski
f941169da3 Document feature_spaces 2021-02-25 12:21:30 +00:00
Travis Ralston
c6ab8d1d37 Docs for loginForWelcome 2021-02-16 15:19:21 -07:00
David Baker
46af8ba17a VoIP virtual rooms, mkII
or: remove the virtual room mapping config option

as per https://github.com/matrix-org/matrix-react-sdk/pull/5639
2021-02-12 20:59:17 +00:00
J. Ryan Stinnett
bf5a69d3a0 Document the mobile guide toast option
Part of https://github.com/vector-im/element-web/issues/16283
2021-01-28 17:28:52 +00:00
David Baker
342d0474fd
Merge pull request #16236 from vector-im/dbkr/voip_user_mapper
Docs for the VoIP translate pattern option
2021-01-22 14:11:54 +00:00
David Baker
f8b9958010 Docs for the voip translate pattern option 2021-01-21 19:23:57 +00:00
Travis Ralston
40f2ba8205
Fix Riot->Element in permalinkPrefix docs 2021-01-20 14:39:01 -07:00
J. Ryan Stinnett
d8408933f1 Upgrade warning severity 2020-12-10 14:29:38 +00:00
J. Ryan Stinnett
ec781b3ebe Document pull request previews
This documents the pull request previews we recently added when working on
https://github.com/vector-im/element-web/issues/12624.
2020-12-09 13:59:45 +00:00
J. Ryan Stinnett
301ea6a5f3
Merge pull request #15277 from akissinger/katex
added katex.min.css to webpack for math support (main PR in matrix-react-sdk)
2020-11-27 11:55:56 +00:00
Aleks Kissinger
e743a12f30 matched setting name to PR in matrix-react-sdk 2020-11-26 17:40:14 +00:00
J. Ryan Stinnett
f1e89bf833 Replace various instances of Riot with Element 2020-11-25 17:01:19 +00:00
Travis Ralston
71206e8e3d Add documentation for new UIFeature flag regarding room history settings 2020-10-27 19:23:06 -06:00
J. Ryan Stinnett
4d2e4d30ca Update translation project names 2020-10-21 13:23:38 +01:00
J. Ryan Stinnett
6420120dd4 Update Weblate URL 2020-10-21 13:16:43 +01:00
J. Ryan Stinnett
f37b63a6cb
Fix file extension
Co-authored-by: Travis Ralston <travpc@gmail.com>
2020-10-16 11:22:28 +01:00
J. Ryan Stinnett
7793f07c81 Document customisation points
https://github.com/matrix-org/matrix-react-sdk/pull/5327 adds a concept of
"customisation points" to keep custom functionality contained. This adds some
general guidance on how to use them.
2020-10-15 18:01:38 +01:00
Aleks Kissinger
89ce904ebb Merge branch 'develop' into katex 2020-10-10 19:32:35 +01:00
Aleks Kissinger
1dae7df28a added doc for latex_maths feature flag 2020-10-10 19:01:30 +01:00
Hubert Chathi
49fd9f827d document dehydration feature flag 2020-10-06 15:29:45 -04:00
J. Ryan Stinnett
4753a49819
Merge pull request #15325 from resynth1943/patch-3
Update Riot -> Element in docs/feature-flags.md
2020-09-30 13:41:02 +01:00
Qt Resynth
db08128954
Riot -> Element 2020-09-30 12:04:01 +00:00
Qt Resynth
48f71f26e7
Apply suggestions from code review
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-09-30 11:58:44 +00:00
Qt Resynth
21329f17c9
Update Riot -> Element in docs/review.md 2020-09-30 11:05:19 +00:00
Qt Resynth
407777539f
Moar Element 'n' Stuff
Gotta fix that up :-) 
Man this is how I spend my free time
2020-09-30 11:00:02 +00:00
J. Ryan Stinnett
307f7c23e9 Document config for preferring Secure Backup setup methods
Part of https://github.com/vector-im/element-web/issues/15238
2020-09-21 15:56:38 +01:00
Travis Ralston
c364215d53 Add missing options 2020-09-18 12:24:06 -06:00
Travis Ralston
72d1950bea Update documentation for UI Features 2020-09-17 22:22:11 -06:00
Travis Ralston
85979079f1 Add end-user documentation for UI features 2020-09-14 22:28:57 -06:00
J. Ryan Stinnett
bc1cad01c4 Add testing to review guidelines
This adds a initial statement on testing to the review guidelines. No
requirements are made at this time, but reviewers are encouraged to request
tests where they believe it is reasonable to provide them.

Fixes https://github.com/vector-im/element-web/issues/14945
2020-08-26 15:57:31 +01:00
J. Ryan Stinnett
a3b8c67e79
Merge pull request #15003 from vector-im/jryans/secure-backup-required
Document .well-known E2EE secure backup setting
2020-08-24 17:33:05 +01:00
J. Ryan Stinnett
3800fe0c9b Use io.element instead of im.vector
This also fixes casing as well to match the latest thinking.
2020-08-24 16:34:58 +01:00
Travis Ralston
b4173f3e08 Add docs for labs flag 2020-08-20 19:46:19 -06:00
Travis Ralston
5f03004664
Merge pull request #14986 from vector-im/travis/settings-v3
Settings v3: Update documentation and configs for new feature flag behaviour
2020-08-19 11:57:00 -06:00
J. Ryan Stinnett
7435175a76
Merge pull request #14952 from vector-im/Custom_jitsi_android
Update jitsi.md
2020-08-19 18:19:17 +01:00
J. Ryan Stinnett
8cfb0a71a0
Apply suggestions from code review 2020-08-19 18:18:50 +01:00
J. Ryan Stinnett
fa265e498f Document new setting to require secure backup
This adds notes on configuring the new `.well-known` setting to require Element
users to set up secure backup before continuing into the app.

Part of https://github.com/vector-im/element-web/issues/14954
2020-08-19 16:22:56 +01:00
J. Ryan Stinnett
8b0eafe50f Document new .well-known for E2EE settings
This updates documentation about the new key in `.well-known` that we'll check
for E2EE settings: `im.vector.e2ee`.

Part of https://github.com/vector-im/element-web/issues/14954
2020-08-19 16:22:56 +01:00
Travis Ralston
2c952b422b Update config.md for new feature behaviour 2020-08-17 14:02:19 -06:00
Travis Ralston
3e924941c3 Update feature flags documentation for new feature behaviour 2020-08-17 14:00:04 -06:00
Michael Telatynski
305570d8e3 Document new labs tweaks 2020-08-14 10:56:30 +01:00
Valere
993fd04353
Update jitsi.md
Updated Element Android section
2020-08-13 19:09:36 +02:00
Michael (a.k.a. Resynth)
de6d72fe3e
Fix typo in https://
See [this comment[(https://github.com/vector-im/riot-web/pull/14581#discussion_r461553693).
2020-07-28 13:59:01 +00:00
J. Ryan Stinnett
37b75eaf31
Merge branch 'develop' into resynth1943-patch-riot-to-element 2020-07-21 10:20:02 +01:00
Resynth
622ea3ead6
Update labs.md 2020-07-18 11:07:59 +00:00
Resynth
7598942800
Update labs.md 2020-07-18 11:07:33 +00:00
Travis Ralston
ef16ef4272 Remove labs info for the new room list 2020-07-17 16:27:03 -06:00
Resynth
b1cf1a2d1a Update docs/translating.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
a8a6c538fa Update docs/skinning thoughts.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
9be8c1c8b0 Update docs/skinning thoughts.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
6b317798dc Update docs/review.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
resynth1943
9fa8b7a9b3 Update docs/labs.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:44 +01:00
Resynth
dde3f93822 Update translating.md 2020-07-17 13:04:03 +01:00
Resynth
ffd802f726 Update translating-dev.md 2020-07-17 13:04:03 +01:00
Resynth
55ea61b36c Update theming.md 2020-07-17 13:04:03 +01:00
Resynth
44c15df58e Update skinning thoughts.md 2020-07-17 13:04:03 +01:00
Resynth
17649dc2b1 Update review.md 2020-07-17 13:04:03 +01:00
Resynth
5d8b246ef1 Update native-node-modules.md 2020-07-17 13:04:03 +01:00
Resynth
0f159c5d77 Update memory-profiles-and-leaks.md 2020-07-17 13:04:03 +01:00
Resynth
f2b9bd4c49 Update labs.md 2020-07-17 13:04:03 +01:00
Resynth
bbd1974eb4 Update jitsi-dev.md 2020-07-17 13:04:03 +01:00
Resynth
6f04841e4b Update e2ee.md 2020-07-17 13:04:03 +01:00
Resynth
7c4cef614e Update config.md 2020-07-17 13:04:03 +01:00
Resynth
f8ed536bb8 Update jitsi.md 2020-07-17 13:04:03 +01:00
Resynth
9687575c86 Change Riot → Element in docs/feature-flags.md 2020-07-17 13:04:03 +01:00
Jorik Schellekens
f5209c0d7e Merge branch 'develop' of github.com:vector-im/riot-web into joriks/delabs-font-scaling 2020-07-14 21:51:41 +01:00
Travis Ralston
e6706b0e7b Merge branch 'develop' into travis/room-list/enable 2020-07-10 21:34:42 -06:00
Travis Ralston
28b5b0b552 Update labs.md for new room list 2020-07-07 14:00:52 -06:00
Jorik Schellekens
817759f590 Remove font scaling from labs 2020-07-06 15:45:30 +01:00
Jorik Schellekens
e95036405b Release the irc layout to the wild 2020-07-06 15:22:57 +01:00
Andrew Morgan
993155d56a Add the new spinner feature 2020-06-26 11:02:55 +01:00
Bruno Windels
fe0ed2b4f3
Update docs/theming.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-06-24 13:15:59 +00:00
Bruno Windels
2ce448943b add documentation for fonts in custom theme 2020-06-24 14:55:57 +02:00