Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rephrased the instruction to configure app in readme.md and contributing.md #21673

Closed
wants to merge 5 commits into from
Closed

Rephrased the instruction to configure app in readme.md and contributing.md #21673

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3ac7388
doc/clarify-readme
bolu-tife Apr 4, 2022
5ed72f7
doc/clarify-dev-environment-instruction
bolu-tife Apr 4, 2022
7819975
Update README.md
bolu-tife Apr 22, 2022
bdee321
Update config.md
bolu-tife Apr 22, 2022
7f0ba3e
Update config.md
bolu-tife Apr 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 also customize it. See the [configuration docs](docs/config.md) for details.
bolu-tife marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down Expand Up @@ -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 <https://develop.element.io> - 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 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.
Expand Down Expand Up @@ -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 also customize it.
See the [configuration docs](docs/config.md) for details.
bolu-tife marked this conversation as resolved.
Show resolved Hide resolved

Finally, build and start Element itself:

Expand Down
3 changes: 1 addition & 2 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 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)
bolu-tife marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For this documentation, config.sample.json is not necessarily at the same level or place as config.json. The existing language to say copying the sample to the config.json file felt clear enough?

"You can also customize it." is also somewhat irrelevant when looking at this doc - I think that sentence can be removed.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I meant the config.json file to be in the same folder as the config.sample.json (element-web folder).

The existing language implied there was already a config,json file. I had issues interpreting it as well as a few other people from the #element-web:matrix.org group chat. I thought it would be better to clarify it for new contributors.

on Matrix.

For a good example of a production-tuned config, see https://app.element.io/config.json
Expand Down