From 3ac7388c8b2accf919c9c1e0dadb06e401796770 Mon Sep 17 00:00:00 2001 From: Boluwatife Omosowon Date: Mon, 4 Apr 2022 19:42:34 +0100 Subject: [PATCH 1/5] doc/clarify-readme --- README.md | 14 ++++++++------ docs/config.md | 3 +-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 75049acdaec..a6a179582d1 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ released version of Element: 1. Untar the tarball on your web server 1. Move (or symlink) the `element-x.x.x` directory to an appropriate name 1. Configure the correct caching headers in your webserver (see below) -1. Configure the app by copying `config.sample.json` to `config.json` and - modifying it. See the [configuration docs](docs/config.md) for details. +1. Configure the app by making a copy of the `config.sample.json` and renaming it as + `config.json` within the same directory. You can customize it. See the [configuration docs](docs/config.md) for details. 1. Enter the URL into your browser and log into Element! Releases are signed using gpg and the OpenPGP standard, and can be checked against the public key located @@ -132,8 +132,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread environment](#setting-up-a-dev-environment) below). Alternatively, you can use - the continuous integration release of the develop branch. -1. Configure the app by copying `config.sample.json` to `config.json` and - modifying it. See the [configuration docs](docs/config.md) for details. +1. Configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can customize it. See the [configuration docs](docs/config.md) for details. 1. `yarn dist` to build a tarball to deploy. Untaring this file will give a version-specific directory containing all the files that need to go on your web server. @@ -311,9 +310,12 @@ Clone the repo and switch to the `element-web` directory: git clone https://github.com/vector-im/element-web.git cd element-web ``` +The `matrix-js-sdk`, `matrix-react-sdk` and `element-web` folders should be at the same level. -Configure the app by copying `config.sample.json` to `config.json` and -modifying it. See the [configuration docs](docs/config.md) for details. + + Configure the app by making a copy of the `config.sample.json` and renaming it as + `config.json` within the same directory. You can customize it. + See the [configuration docs](docs/config.md) for details. Finally, build and start Element itself: diff --git a/docs/config.md b/docs/config.md index 833754e107f..724bf6eb684 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,7 +1,6 @@ # Configuration -You can configure the app by copying `config.sample.json` to `config.json` and customising it. The possible options are -described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) +You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can customize it. The possible options are described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix. For a good example of a production-tuned config, see https://app.element.io/config.json From 5ed72f7745c5747473c65aad0ab9c41f74d15987 Mon Sep 17 00:00:00 2001 From: Boluwatife Omosowon Date: Mon, 4 Apr 2022 23:52:04 +0100 Subject: [PATCH 2/5] doc/clarify-dev-environment-instruction --- README.md | 6 +++--- docs/config.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a6a179582d1..ff502db1259 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ released version of Element: 1. Move (or symlink) the `element-x.x.x` directory to an appropriate name 1. Configure the correct caching headers in your webserver (see below) 1. Configure the app by making a copy of the `config.sample.json` and renaming it as - `config.json` within the same directory. You can customize it. See the [configuration docs](docs/config.md) for details. + `config.json` within the same directory. You can also customize it. See the [configuration docs](docs/config.md) for details. 1. Enter the URL into your browser and log into Element! Releases are signed using gpg and the OpenPGP standard, and can be checked against the public key located @@ -132,7 +132,7 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread environment](#setting-up-a-dev-environment) below). Alternatively, you can use - the continuous integration release of the develop branch. -1. Configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can customize it. See the [configuration docs](docs/config.md) for details. +1. Configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can also customize it. See the [configuration docs](docs/config.md) for details. 1. `yarn dist` to build a tarball to deploy. Untaring this file will give a version-specific directory containing all the files that need to go on your web server. @@ -314,7 +314,7 @@ The `matrix-js-sdk`, `matrix-react-sdk` and `element-web` folders should be at t Configure the app by making a copy of the `config.sample.json` and renaming it as - `config.json` within the same directory. You can customize it. + `config.json` within the same directory. You can also customize it. See the [configuration docs](docs/config.md) for details. Finally, build and start Element itself: diff --git a/docs/config.md b/docs/config.md index 724bf6eb684..6785eae3f40 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,6 +1,6 @@ # Configuration -You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can customize it. The possible options are described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) +You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can also customize it. The possible options are described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix. For a good example of a production-tuned config, see https://app.element.io/config.json From 781997540a01f4a11f1dbf6b10b84180ba6dce99 Mon Sep 17 00:00:00 2001 From: Boluwatife Omosowon <59070723+bolu-tife@users.noreply.github.com> Date: Fri, 22 Apr 2022 15:30:49 +0100 Subject: [PATCH 3/5] Update README.md --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ff502db1259..5d35bf74975 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,8 @@ released version of Element: 1. Move (or symlink) the `element-x.x.x` directory to an appropriate name 1. Configure the correct caching headers in your webserver (see below) 1. Configure the app by making a copy of the `config.sample.json` and renaming it as - `config.json` within the same directory. You can also customize it. See the [configuration docs](docs/config.md) for details. + `config.json` within the same directory. You can also customize it. See the + [configuration docs](docs/config.md) for details. 1. Enter the URL into your browser and log into Element! Releases are signed using gpg and the OpenPGP standard, and can be checked against the public key located @@ -132,8 +133,10 @@ guide](https://classic.yarnpkg.com/en/docs/install) if you do not have it alread environment](#setting-up-a-dev-environment) below). Alternatively, you can use - the continuous integration release of the develop branch. -1. Configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can also customize it. See the [configuration docs](docs/config.md) for details. -1. `yarn dist` to build a tarball to deploy. Untaring this file will give +1. Configure the app by making a copy of the `config.sample.json` and renaming it as +`config.json` within the same directory. You can also customize it. See the +[configuration docs](docs/config.md) for details. +3. `yarn dist` to build a tarball to deploy. Untaring this file will give a version-specific directory containing all the files that need to go on your web server. @@ -313,9 +316,9 @@ cd element-web The `matrix-js-sdk`, `matrix-react-sdk` and `element-web` folders should be at the same level. - Configure the app by making a copy of the `config.sample.json` and renaming it as - `config.json` within the same directory. You can also customize it. - See the [configuration docs](docs/config.md) for details. +Configure the app by making a copy of the `config.sample.json` and renaming it as +`config.json` within the same directory. You can also customize it. +See the [configuration docs](docs/config.md) for details. Finally, build and start Element itself: From bdee3216a9796bf5436e3e8854d66d0ab0f381f1 Mon Sep 17 00:00:00 2001 From: Boluwatife Omosowon <59070723+bolu-tife@users.noreply.github.com> Date: Fri, 22 Apr 2022 15:39:53 +0100 Subject: [PATCH 4/5] Update config.md --- docs/config.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index 6785eae3f40..aac0431b77c 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,7 +1,8 @@ # Configuration -You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` within the same directory. You can also customize it. The possible options are described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) -on Matrix. +You can configure the app by making a copy of the `config.sample.json` and renaming it as +`config.json`. The possible options are described here. If you run into issues, please visit +[#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix. For a good example of a production-tuned config, see https://app.element.io/config.json From 7f0ba3ef8eef705466bc96dbc5732a134d37ae15 Mon Sep 17 00:00:00 2001 From: Boluwatife Omosowon <59070723+bolu-tife@users.noreply.github.com> Date: Fri, 22 Apr 2022 15:51:38 +0100 Subject: [PATCH 5/5] Update config.md --- docs/config.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index aac0431b77c..0fcf47cb06d 100644 --- a/docs/config.md +++ b/docs/config.md @@ -1,7 +1,7 @@ # Configuration -You can configure the app by making a copy of the `config.sample.json` and renaming it as -`config.json`. The possible options are described here. If you run into issues, please visit +You can configure the app by making a copy of the `config.sample.json` and renaming it as `config.json` +within the same directory. The possible options are described here. If you run into issues, please visit [#element-web:matrix.org](https://matrix.to/#/#element-web:matrix.org) on Matrix. For a good example of a production-tuned config, see https://app.element.io/config.json