Commit graph

355 commits

Author SHA1 Message Date
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
Travis Ralston
cbf35a6060 Mark the new room list as ready for general testing 2020-06-18 15:46:04 -06:00
Michael Telatynski
bce0bf1b1d
Apply suggestions from code review
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-06-04 12:38:45 +01:00
Michael Telatynski
faca8799db Add e2ee-default:false docs
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-06-03 22:10:48 +01:00
Arthur Lutz
d0413f0d15
[docs/config.md] typo fix 2020-06-03 14:59:34 +02:00
Michael Telatynski
c29dc0bad8 Remove cross-signing from labs
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-06-03 10:44:42 +01:00
Michael Telatynski
af8fb33b83 add line
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-28 14:28:14 +01:00
Michael Telatynski
361cc4ab5c Add app-load doc
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-28 14:26:51 +01:00
Travis Ralston
6f7570d877
Merge branch 'develop' into travis/room-list-2 2020-05-21 13:29:20 -06:00
Travis Ralston
03414d92d0
Merge pull request #13352 from vector-im/revert-13351-revert-13199-joriks/font-sclaing-slider
Add font scaling labs setting.
2020-05-20 10:05:28 -06:00
Travis Ralston
aae5e4c234
Merge pull request #13350 from JorikSchellekens/joriks/font-sclaing-slider
Add labs flag for alternate message layouts
2020-05-19 14:53:01 -06:00
Jorik Schellekens
3a7578b7ee Remove avatar flag 2020-05-19 18:30:30 +01:00
Travis Ralston
81010a4f2f Add docs for room list labs flag 2020-05-14 14:24:34 -06:00
Jorik Schellekens
585cfbbaf9 Update docs 2020-05-07 16:18:11 +01:00
Michael Telatynski
f4e21c3fc7 Remove electron_app as we now have riot-desktop repo
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-05-06 11:32:13 +01:00
Jorik Schellekens
6d19d1b346 Change setting location. 2020-04-28 16:56:23 +01:00
Bruno Windels
5c77b0371a add line break 2020-04-28 11:07:16 +02:00
Bruno Windels
1c413a4f81 clarify how to use in CSS 2020-04-27 20:17:13 +02:00
Bruno Windels
f55c5aedc1 update docs with custom theming changes 2020-04-27 19:44:05 +02:00
Travis Ralston
215ad07493 Remove docs and config for invite only padlocks
See https://github.com/matrix-org/matrix-react-sdk/pull/4487
2020-04-24 10:03:14 -06:00
Travis Ralston
58bf82186c
Revert "Revert "Add font scaling labs setting."" 2020-04-23 13:17:20 -06:00
Travis Ralston
2c62d47e6c
Revert "Add font scaling labs setting." 2020-04-23 13:16:49 -06:00
Jorik Schellekens
4f7081fc2b Add labs flag for alternate message layouts 2020-04-23 19:12:10 +01:00
J. Ryan Stinnett
fa223b94bc
Merge pull request #13341 from vector-im/jryans/feature-flags-releases
Expand feature flag docs to cover additional release channels
2020-04-23 15:33:51 +01:00
J. Ryan Stinnett
527d18ac42 riot-desktop now has a develop branch 2020-04-23 15:20:42 +01:00
J. Ryan Stinnett
2774b046b3 Expand feature flag docs to cover additional release channels
This adds further detail around the various additional release channels we have
for desktop. It also expands on the current state of enabling a feature by
default.
2020-04-23 11:06:15 +01:00
Jorik Schellekens
6873b48c42
Merge pull request #13199 from JorikSchellekens/joriks/font-sclaing-slider
Add font scaling labs setting.
2020-04-23 10:30:40 +01:00
Jorik Schellekens
3e21483b82 Try to silence the e2e test
Merge branch 'develop' of github.com:vector-im/riot-web into joriks/font-sclaing-slider
2020-04-23 10:19:45 +01:00
Travis Ralston
c23b2415e4 Remove encrypted message search feature flag
See https://github.com/matrix-org/matrix-react-sdk/pull/4467
2020-04-22 10:59:47 -06:00
Travis Ralston
6b1965388e
Merge pull request #13312 from vector-im/travis/docs-settings-fix
Fix `default_federate` settting description
2020-04-22 08:36:17 -06:00
Travis Ralston
601816862f
Clarify that the .well-known method for Jitsi isn't available yet
We should remove this at release time, but if we forget it should be vaguely worded well enough.

People keep assuming it'll just work even though the feature hasn't launched yet. The original theory was that a release was around the corner, but it's since been pushed back several times.
2020-04-21 13:27:05 -06:00
Travis Ralston
25dbeca083
Fix default_federate settting description 2020-04-21 09:27:03 -06:00
Jorik Schellekens
7d74e789ca Fix slight innacuracy. 2020-04-21 15:18:22 +01:00
Jorik Schellekens
abcf0b73c0 Docs on font-scaling 2020-04-21 10:05:05 +01:00
Michael Kohler
752b6b63ec Document more config options in config.md (fixes #13089)
Signed-off-by: Michael Kohler <me@michaelkohler.info>
2020-04-19 11:44:58 +02:00
The Stranjer
3a551f2da5 Allow admins to create an array of backgrounds to be randomly chosen from 2020-04-17 06:31:49 -04:00
Travis Ralston
bea0dab623 Update cross-signing feature docs and document fallback procedures
For https://github.com/matrix-org/matrix-react-sdk/pull/4416
2020-04-16 11:35:28 -06:00
Sean Cross
e536b07874 docs: labs: add a pointer to config.md
The documentation mentions that Labs features can be manipulated by
opening the Settings menu and selecting Labs.  This feature is normally
disabled, so for most users this is not the case.

Add a link to the `config.md` file and a note that the Labs features
must be enabled in order to manipulate them.

Signed-off-by: Sean Cross <sean@xobs.io>
2020-04-13 13:48:10 +08:00
Travis Ralston
83088961d0 Mention Jitsi support at the .well-known level in Jitsi docs
For https://github.com/matrix-org/matrix-react-sdk/pull/4348
2020-04-06 16:12:36 -06:00
Travis Ralston
99f8019aa2 Update docs per suggestions 2020-04-06 14:50:06 -06:00
Travis Ralston
abf475ee80 Add some docs about Jitsi widgets and Jitsi configuration 2020-04-03 13:25:33 -06:00
David Baker
421fcb115f Give the jitsi wrapper its own external api script 2020-04-01 10:38:49 +01:00
Jorik Schellekens
6ed81eadbf Some grammar and clarifications. 2020-03-30 11:52:23 +01:00
J. Ryan Stinnett
da249cbc40 Merge remote-tracking branch 'origin/develop' into jryans/review-policy 2020-03-26 11:34:29 +00:00
J. Ryan Stinnett
5b94d8bbd7 Add line about UI for network activity 2020-03-26 11:28:51 +00:00
Travis Ralston
775e1fc4ae
Merge pull request #12780 from vector-im/travis/wrapped-jitsi
Use a local widget wrapper for Jitsi calls
2020-03-19 11:52:22 -06:00
Michael Telatynski
9055d0b8b5
Delete shortcuts.md
The in-app keyboard shortcuts view has more.
https://github.com/matrix-org/matrix-react-sdk/pull/4231
2020-03-19 10:52:48 +00:00
Travis Ralston
e1eb16ce46 Use a local widget wrapper for Jitsi calls
Effectively fixes https://github.com/vector-im/riot-web/issues/11074
Effectively fixes https://github.com/vector-im/riot-web/issues/7112
Fixes https://github.com/vector-im/riot-web/issues/6930
Fixes Jitsi widgets not working for guests (https://github.com/vector-im/riot-web/issues/8933)
Fixes https://github.com/vector-im/riot-web/issues/5048

Previously we were relying on an integration manager to be defined, functional, and alive in order to join Jitsi calls. This commit changes this so we aren't reliant on an integration manager for Jitsi calls at all, and gives people the option of choosing a Jitsi server via the config.json.

This side is just the wrapper/shell: the logic is mostly in the react-sdk (to be linked via PRs). This layer simply has an HTML file exported that can be used to render a Jitsi widget, and the react-sdk constructs a URL to access it locally. This is similar to how the mobile apps handle Jitsi widgets: instead of iframing the widget URL directly into the app, they pull apart the widget information and natively render it. We're effectively doing the same here by parsing the widget options and using our local wrapper instead of whatever happens to be defined in the widget state event.

Integration managers should still continue to offer a widget URL for Jitsi widgets as this is what the spec requires.

A large part of this is based upon Dimension's handling of Jitsi and widgets in general: a license has been granted to allow Riot (and therefore the react-sdk) to use the code and be inspired by it.
2020-03-18 15:48:02 -06:00
J. Ryan Stinnett
5808ea2ba1 Add notes about chatting with the team 2020-03-18 11:18:29 +00:00
J. Ryan Stinnett
e348546e59 Reformat 2020-03-18 10:59:46 +00:00
J. Ryan Stinnett
34f3671c09 Add notes on review request handling 2020-03-18 10:59:33 +00:00
J. Ryan Stinnett
3989f41985 Clarify merge options 2020-03-18 10:53:48 +00:00
J. Ryan Stinnett
bd8b3a9046 Move multi-repo linking to workflow section 2020-03-18 10:21:28 +00:00
J. Ryan Stinnett
1aecc3d7e5
Add multi-repo PR linking
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-03-18 10:18:41 +00:00
J. Ryan Stinnett
0b772ca50a
Tweak issue assigning
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2020-03-13 16:48:03 +00:00
J. Ryan Stinnett
d930d14735 Add review policy doc
This documents various attributes of our overall review policy from code,
design, and product perspectives.

Fixes https://github.com/vector-im/riot-web/issues/12614
2020-03-13 16:39:29 +00:00
Travis Ralston
98bd951366 Add docs and flag for custom theme support 2020-03-13 09:34:16 -06:00