Commit graph

232 commits

Author SHA1 Message Date
Shreeya
f029b68ad4
Updated 'Setting up a dev environment' in README.md (#21597) 2022-03-30 13:52:15 +01:00
Michael Kaye
5eecc768a3
Docs: Require creation of config.json as part of Getting Started (#21590)
* Require creation of config.json

Change the language from "If desired" to "Configure" to ensure people do not miss this step, as skipping this step will show the error "Invalid configuration: no default server specified."

* Update README.md

Rollback unintentioned bullet point `3` change
2022-03-29 16:40:07 +01:00
Travis Ralston
585b651b4c
Update nodejs version requirements (#21484)
While we do technically support v14, it's fallen into security releases. Let's recommend that people use whatever nodejs itself recommends instead.
2022-03-21 07:38:19 -06:00
Robin
81fdae0d88
Fix typo in README (#21347)
Signed-off-by: Robin Townsend <robin@robin.town>
2022-03-07 17:38:23 -05:00
Germain
de9f427364
Update outdated unit test info in README.md (#20096) 2021-12-08 12:34:34 +00:00
James Salter
e90f7b7e82
Merge pull request #18979 from vector-im/readme-no-cache
Suggest setting Cache-Control: no-cache on / for self-hosters
2021-09-29 13:17:14 +01:00
James Salter
5741baed25 Note that caching is configured in he Dockerfile 2021-09-29 13:14:03 +01:00
James Salter
2d48797294 Suggest setting Cache-Control: no-cache on / for self-hosters 2021-09-10 15:45:13 +01:00
Ekaterina Gerasimova
607c840917 Update README to point to element-meta wiki
Shared processes have moved to element-meta so update README to point
there.
2021-09-03 17:30:01 +01:00
Ekaterina Gerasimova
d806927196 README: link to wiki for issue triage and labels
Signed-off-by: Ekaterina Gerasimova <ekaterinag@element.io>
2021-08-19 08:34:24 +01:00
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
Ezra Barrow
c7809ca751
Update README.md 2021-07-09 17:12:19 -04: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
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
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
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
J. Ryan Stinnett
5808ea2ba1 Add notes about chatting with the team 2020-03-18 11:18:29 +00: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