Commit graph

304 commits

Author SHA1 Message Date
Dariusz Niemczyk
b782d10333
Merge pull request #18628 from psrpinto/hot-reload-follow-up
Hot reload follow up
2021-08-18 18:49:52 +02:00
David Baker
67164147a8 Uupdate README to require node 14
Another place we reference this
2021-08-18 17:30:09 +01:00
Paulo Pinto
feedeabee3 Improve phrasing 2021-08-18 16:39:27 +01:00
Kat Gerasimova
5319b34fd6
Update issue labelling guidelines in README 2021-08-04 10:25:11 +01:00
Kat Gerasimova
2d6a8d3d1e
Make triage wording in README friendlier
Co-authored-by: James Salter <iteration@gmail.com>
2021-08-04 10:19:53 +01:00
Kat Gerasimova
c29ef4bb5f
Add empty line to improve rendering in README
Co-authored-by: Šimon Brandner <simon.bra.ag@gmail.com>
2021-08-03 15:09:53 +01:00
Kat Gerasimova
99c9824e15
Fix typo in triage text in the README
Signed-off-by: Ekaterina Gerasimova <kittykat3756@gmail.com>
2021-08-03 14:08:02 +01:00
Kat Gerasimova
d6606afd72
Improve wording for triage label usage in README
Signed-off-by: Ekaterina Gerasimova <kittykat3756@gmail.com>
2021-08-03 13:35:31 +01:00
Ekaterina Gerasimova
c90430954b Update issue labelling guidelines in README
Add "prevalence" labels to use as a guideline for how often issues crop up.

Combine prevalence and severity to indicate correspondence to how defects
should be prioritised by the team.
2021-08-03 09:13:25 +01:00
Dariusz Niemczyk
a9f3f873a5
Add a .env config and explanation how to use HMR 2021-08-02 14:38:25 +02:00
Jano Garcia
b5d25eb5f8
Fix wrong URL in README.md 2021-07-30 14:10:47 +02:00
Ezra Barrow
c7809ca751
Update README.md 2021-07-09 17:12:19 -04:00
Šimon Brandner
39ef376a79
Use Android SDK instead
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2021-05-05 18:06:42 +02:00
Šimon Brandner
374d8c1c4c
Update link to Android SDK
Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
2021-05-05 08:43:24 +02:00
Niels Basjes
281236432a Provide documentation on how to run on Kubernetes 2021-03-23 11:55:11 +01:00
Germain
740bf51e46
Updated expected webpack output in setup guide 2021-03-22 12:39:26 +00:00
J. Ryan Stinnett
779a4912d5
Merge pull request #16612 from vector-im/jryans/triage-2021
Update triage guide to match the new label scheme
2021-03-10 14:06:37 +00:00
J. Ryan Stinnett
cc81cc714c Add other conceptual themes 2021-03-10 14:05:34 +00:00
J. Ryan Stinnett
6afd289bcb Tweak area label copy 2021-03-05 16:51:25 +00:00
J. Ryan Stinnett
0469805eb1 Update triage guide to match the new label scheme
Element Web issue labels have been changed to match a new scheme that has been
piloted by the [Synapse
team](https://github.com/matrix-org/synapse/issues/9460). The new triage
guidance here is largely borrowed from the Synapse guide, but with some
Element-specifics to reflect how we use priority, add code areas, etc.
2021-03-05 16:36:51 +00:00
J. Ryan Stinnett
5056e14060 Add Edge to the supported tier
Fixes https://github.com/vector-im/element-web/issues/9175
2021-03-05 13:18:15 +00:00
Richard van der Hoff
0d4958319b
README: remove Jenkins reference 2021-02-05 16:16:48 +00:00
Denis Kasak
b22484d203 Add configuration security best practices to the README.
Closes #13870.
2021-02-04 13:24:19 +01:00
J. Ryan Stinnett
64fd07ec73
Merge pull request #15810 from vector-im/jryans/rebrand-packaged-artifact
Update branding of packaging artifacts
2020-11-25 11:16:40 +00:00
J. Ryan Stinnett
6583064cb4 A few additional packaging changes
This renames a few more packaging bits to match the new brand.

Fixes https://github.com/vector-im/element-web/issues/14896
2020-11-24 15:38:48 +00:00
Šimon Brandner
4c1752e18c
Cleanup
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-11-23 18:36:20 +01:00
Šimon Brandner
80e5c22065
Better wording
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-11-23 18:35:29 +01:00
Šimon Brandner
ab95183e4f Added inotify instance limit info 2020-11-23 08:45:21 +01:00
J. Ryan Stinnett
d64639c70a Rename Docker repo in docs
We now have a Docker repo named `element-web`, so this updates docs to match.

Fixes https://github.com/vector-im/element-web/issues/14930
2020-10-28 14:32:25 +00:00
J. Ryan Stinnett
6420120dd4 Update Weblate URL 2020-10-21 13:16:43 +01:00
J. Ryan Stinnett
640fe00d1e Update Weblate URL 2020-10-21 13:14:41 +01:00
Daniel Maslowski
bc0c30f99f fix link to classic yarn's yarn link
Signed-off-by: Daniel Maslowski <info@orangecms.org>
2020-09-29 04:46:59 +02:00
Tom Lant
cad03d0c47
Update README.md
Including `git checkout develop` in the dev env instructions is redundant and confusing (since `develop` is already the default branch)
2020-09-16 21:34:00 +01:00
Weasy
c032067a30
Remove tag from docker build commands 2020-08-22 09:52:05 +02:00
Weasy
c4fae201e9
Address review comments 2020-08-18 23:18:03 +02:00
Weasy
c58a11c537
Update links in README.md to point to Element 2020-08-16 10:59:05 +02:00
J. Ryan Stinnett
ce226ab534 Replace Riot with Element in docs and comments
This only covers the simple cases of references to issues and repos. More
complex areas, such as deployment scripts, will be handled separately.

Part of https://github.com/vector-im/element-web/issues/14864
2020-08-03 18:33:36 +01:00
Resynth
eac628ddcf Update README.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:55 +01:00
Resynth
d9c2b34249 Update README.md
Co-authored-by: J. Ryan Stinnett <jryans@gmail.com>
2020-07-17 13:04:03 +01:00
Resynth
2657df8f3f Change Riot to Element 2020-07-17 13:04:03 +01:00
J. Ryan Stinnett
cda691e359 Tweak Yarn docs link post-review 2020-05-13 11:29:11 +01:00
chagai95
d68b50feb6
Updated link and added:Yarn two is not yet used.
the link was broken and there was no mention of the version of yarn being used.
2020-05-13 11:49:26 +02:00
chagai95
b10fdf3d4b
Added Anchor Link to the development of matrix sdk
The link before just sent you to the matrix sdk repository, now it sends you to the development section.
2020-05-12 13:07:43 +02: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
Danny Colin
1dbbdb252c Add instruction to resolve the inotify watch limit issue
On Linux, it's common that the system limit the number of files that can be monitored. If
this limit is too low then the build script will fail.

Signed-off-by: Danny Colin <contact@dannycolin.com>
2020-04-10 20:09:29 -04:00
C. Yang
2514a33892 Fix broken yarn install link in README.md 2020-04-10 17:43:54 -04:00
Jorik Schellekens
21a41fa343 Update link to css location. 2020-03-30 10:05:40 +01:00
J. Ryan Stinnett
5808ea2ba1 Add notes about chatting with the team 2020-03-18 11:18:29 +00:00
Travis Ralston
74fcb103b1
Link to the right contributing guidelines 2020-03-05 11:04:33 -07:00
J. Ryan Stinnett
b8766d5fb4 Clarify supported tier means desktop OSes
This clarifies that the "supported" tier is for browser and the official app on
desktop OSes only.

Fixes https://github.com/vector-im/riot-web/issues/12421
2020-02-24 16:52:30 +00:00
Michael Telatynski
44ec8198e5 Merge branches 'develop' and 't3chguy/usercontent' of github.com:vector-im/riot-web into t3chguy/usercontent
 Conflicts:
	README.md
2020-02-19 12:51:34 +00:00
J. Ryan Stinnett
e1eb354c1c Add experimental support tier
This updates and rewrites the supported environments portion of the README. It
also adds a new experimental support tier to clarify how we'll handle things
like installed PWAs and mobile web.
2020-02-14 18:04:54 +00:00
Michael Telatynski
22d0d1029e update README
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2020-02-13 16:55:23 +00:00
Travis Ralston
fde32f13a5 [CONFLICT CHUNKS] Merge branch 'develop' into travis/sourcemaps-develop 2020-01-09 14:15:09 -07:00
Pankaj Kumar Singh
a9cae90a52 Signed-off-by Pankaj Singh <singh.pankaj@live.com 2019-12-26 23:11:17 +05:30
Travis Ralston
9865ce899b Add a bunch of docs
We're making an assumption here that the decorator is actually all over the app when it's not.
2019-12-16 16:34:46 -07:00
Travis Ralston
b23318be8d
Clarify which versions of what we support 2019-12-12 10:34:22 -07:00
Travis Ralston
1bd473a1b9 Move caching requirements higher in the readme 2019-11-24 21:54:01 -07:00
Travis Ralston
9790cac065 Merge branch 'develop' into michaelkaye/readme_updates_caching 2019-11-24 21:52:35 -07:00
J. Ryan Stinnett
2c0559dbea Remove mention of CI scripts from docs
This removes `fetch-develop.deps.sh` from the docs, as it's designed more for
use on CI environments and ends up causing confusion when used for anything
else.

Fixes https://github.com/vector-im/riot-web/issues/11247
2019-10-29 10:37:36 +00:00
Bruno Windels
a3a8da1746 provide deep link to e2e instructions in react sdk 2019-10-21 14:13:57 +02:00
Bruno Windels
e2e7303cc3
Update README.md
Co-Authored-By: J. Ryan Stinnett <jryans@gmail.com>
2019-10-18 12:29:17 +00:00
Bruno Windels
d1a5376dae clarify where the e2e tests are located 2019-10-10 16:54:52 +02:00
Bruno Windels
d20b2ee9eb document how to run the e2e tests locally 2019-10-10 16:54:10 +02:00
Michael Kohler
9e27cb713f Add config.json copy instruction to 'Development' as well 2019-10-06 13:04:20 +02:00
Travis Ralston
f97b632c65
Merge pull request #6146 from rugk/patch-1
Clarify that HTTPS is not just needed for VoIP
2019-09-01 09:31:34 -06:00
rugk
658c5b42be
Update README.md
Co-Authored-By: Travis Ralston <travpc@gmail.com>
2019-09-01 13:41:21 +02:00
rugk
f7bab88079
Improve exceptions mention
In addition to fixes from review, also add link to official source with more information.
2019-08-27 22:28:15 +02:00
J. Ryan Stinnett
b93388f504 Restore config.json section for old Riot
Riot includes a link to the config.json section of the README, so let's restore
it (at least for a while) keep that link working.
2019-06-28 13:50:54 +01:00
J. Ryan Stinnett
73d801cb1d Extract configuration docs to separate file
The main README is very busy with too much information in one file. This
attempts to clean up one portion by moving configuration docs to a separate
file.

Fixes https://github.com/vector-im/riot-web/issues/9965
2019-06-27 19:08:33 +01:00
Travis Ralston
42be1d633c Do not fail on server liveliness checks during startup
Also warn about deprecated config option usage.

See https://github.com/vector-im/riot-web/issues/9828
2019-06-04 23:44:33 -06:00
Travis Ralston
cafae31827 Add docs for defaultCountryCode 2019-05-31 21:23:58 -06:00
Travis Ralston
98f2d865b9 Add 'showLabsSettings' flag to docs+sample config 2019-05-30 20:03:42 -06:00
J. Ryan Stinnett
734d8a8151 Clarify Electron steps 2019-05-24 11:28:12 +01:00
Travis Ralston
ab6ba0e0d8 Add some clarity to the config options 2019-05-03 11:06:32 -06:00
Travis Ralston
f08491cee8 Validate default homeserver config before loading the app
Implements the process described here: https://github.com/vector-im/riot-web/issues/9290#issuecomment-481966910

The expectation is that later layers (like the react-sdk) will make use of the `validated_discovery_config` option instead of interpreting the config themselves.

We intentionally block the UI from loading here to avoid races between discovery and the app loading.
2019-05-03 11:06:32 -06:00
Travis Ralston
9957149115
Merge pull request #9426 from vector-im/travis/dockerfile-continued
Add Dockerfile (part 2)
2019-05-01 10:42:21 -06:00
Richard van der Hoff
cc5911b4aa
Remove redundant and incorrect riot-desktop install instructions (#9558) 2019-04-25 13:22:32 +01:00
axel simon
434e8cc937
Changed the Debian repo key and public key URLs 2019-04-16 21:03:53 +02:00
axel simon
6c950593b7
the repo key filename changed, reflecting this 2019-04-16 17:58:54 +02:00
David Baker
147f77f1dc Update README.md
better wording

Co-Authored-By: axelsimon <github@axelsimon.net>
2019-04-16 17:55:49 +02:00
axel simon
261974e9eb
update installation instructions with new repo
change mentions of https://riot.im/packages to https://packages.riot.im
add instructions to remove old, now-untrusted riot.im signing key
update language and move from 'apt-get` to the simpler `apt`
2019-04-16 13:53:59 +02:00
Travis Ralston
a263ca8cb3 Add USE_CUSTOM_SDKS to docs 2019-04-10 15:51:06 -06:00
Travis Ralston
eeae5dbcad Add docs for the Docker image 2019-04-10 15:47:12 -06:00
pacien
2c9b51f29d Add support for custom profile directory
A custom user data directory can now be specified using the "profile-dir"
command line argument.

Github ref: closes #6175

Signed-off-by: Pacien TRAN-GIRARD <pacien.trangirard@pacien.net>
2019-04-09 19:35:14 +02:00
Andrew Morgan
8a48d9e86b
Remove vector-electron-desktop from README
The repo (https://github.com/iskrisis/vector-electron-desktop) very clearly states not to use it anymore.
2019-04-08 17:11:58 +01:00
Jonas Jelten
5a051824c0 configure auth footer links through sdkconfig
Signed-off-by: Jonas Jelten <jelten@in.tum.de>
2019-03-28 12:32:10 +01:00
Ben Parsons
d098857d5a wrap text and link from README.md 2019-03-22 14:49:44 +00:00
J. Ryan Stinnett
34e533dd4b Remove Edge from browser support statements
At the current time, we do not intend to do additional work specifically to
support Edge.  If it works for most use cases, that's great, but we do not
intend to fix issues that affect only Edge.

Fixes https://github.com/vector-im/riot-web/issues/9201
2019-03-18 15:47:48 +00:00
Travis Ralston
abb6bee44d
Merge pull request #9177 from vector-im/travis/browser-support-docs
Declare the officially supported browsers in the README
2019-03-15 12:04:17 -06:00
J. Ryan Stinnett
faa9932c77
Merge pull request #9011 from vector-im/t3chguy/local-config
Document some desktop app things
2019-03-15 17:53:55 +00:00
J. Ryan Stinnett
95611d2c12
Update README.md grammar 2019-03-15 17:53:20 +00:00
Travis Ralston
631fcb0ad2 Cross-promote mobile apps 2019-03-15 11:43:00 -06:00
Travis Ralston
e47728e0e4 Declare the officially supported browsers in the README
Fixes https://github.com/vector-im/riot-web/issues/8701
2019-03-14 12:59:57 -06:00
J. Ryan Stinnett
fcaf0a5503 Recommend using the latest Node LTS version 2019-03-13 10:54:36 +00:00
J. Ryan Stinnett
92a9f13452 Recommend using the latest Node LTS version 2019-03-13 10:53:53 +00:00
J. Ryan Stinnett
1312ba537a Update scripts and docs to use yarn where appropriate
Most `npm` operations are replaced with `yarn`, which generally has better
behavior. However, steps like publish that write to the NPM registry are left to
`npm`, which currently handles these tasks best.
2019-03-12 11:06:57 +00:00
J. Ryan Stinnett
337ac2f6a0 Reorder link and install steps
Take advantage of Yarn's preservation of links while installing and set up links
first and install second. This should result in a small speedup since we no
longer install the published SDKs just to replace them on the next line.
2019-03-11 18:36:45 +00:00
J. Ryan Stinnett
7c947d87ab Update scripts and docs to use yarn where appropriate
Most `npm` operations are replaced with `yarn`, which generally has better
behavior. However, steps like publish that write to the NPM registry are left to
`npm`, which currently handles these tasks best.
2019-03-11 14:22:02 +00:00
Michael Telatynski
01becf00f5 Try and improve README
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
2019-03-01 08:01:26 +00:00