mirror of
https://github.com/vector-im/element-web.git
synced 2026-05-26 05:53:55 +00:00
Update links to old repo
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
This commit is contained in:
Michael Telatynski
@@ -72,7 +72,7 @@ Element can also be run as a desktop app, wrapped in Electron. You can download
|
||||
pre-built version from <https://element.io/get-started> or, if you prefer,
|
||||
build it yourself.
|
||||
|
||||
To build it yourself, follow the instructions at <https://github.com/element-hq/element-desktop>.
|
||||
To build it yourself, follow the instructions at <https://github.com/element-hq/element-web/tree/develop/apps/desktop>.
|
||||
|
||||
Many thanks to @aviraldg for the initial work on the Electron integration.
|
||||
|
||||
|
||||
@@ -4,12 +4,12 @@ All Element Web options documented [here](https://github.com/vector-im/element-w
|
||||
|
||||
---
|
||||
|
||||
The app contains a configuration file specified at build time using [these instructions](https://github.com/vector-im/element-desktop/#config).
|
||||
This config can be overwritten by the end using by creating a `config.json` file at the paths described [here](https://github.com/vector-im/element-desktop/#user-specified-configjson).
|
||||
The app contains a configuration file specified at build time using [these instructions](https://github.com/element-hq/element-web/blob/develop/apps/desktop/README.md#config).
|
||||
This config can be overwritten by the end using by creating a `config.json` file at the paths described [here](https://github.com/element-hq/element-web/blob/develop/apps/desktop/README.md#user-specified-configjson).
|
||||
|
||||
After changing the config, the app will need to be exited fully (including via the task tray) and re-started.
|
||||
|
||||
---
|
||||
|
||||
1. `update_base_url`: Specifies the URL of the update server, see [document](https://github.com/vector-im/element-desktop/blob/develop/docs/updates.md).
|
||||
1. `update_base_url`: Specifies the URL of the update server, see [document](https://github.com/element-hq/element-web/blob/develop/apps/desktop/docs/updates.md).
|
||||
2. `web_base_url`: Specifies the Element Web URL when performing actions such as popout widget. Defaults to `https://app.element.io/`.
|
||||
|
||||
@@ -13,7 +13,7 @@ you will need debug symbols.
|
||||
2. Figure out which version of Electron your Element-Desktop is based on. The
|
||||
best way to do this is to figure out the version of Element-Desktop, then
|
||||
look at
|
||||
[`package.json`](https://github.com/element-hq/element-desktop/blob/develop/package.json)
|
||||
[`package.json`](https://github.com/element-hq/element-web/blob/develop/apps/desktop/package.json)
|
||||
for the corresponding version. There will be an entry within `dependencies` of
|
||||
`electron`: the value will tell you the version of Electron that was used for that version of Element-Desktop.
|
||||
|
||||
|
||||
@@ -33,13 +33,13 @@ pnpm link docker/node_modules/matrix-seshat
|
||||
|
||||
... and build the app with `pnpm build` or run it with `pnpm start`.
|
||||
|
||||
(See also https://github.com/element-hq/element-desktop#docker.)
|
||||
(See also https://github.com/element-hq/element-web/blob/develop/apps/desktop/README.md#docker.)
|
||||
|
||||
## Building
|
||||
|
||||
Install the pre-requisites for your system:
|
||||
|
||||
- [Windows pre-requisites](https://github.com/vector-im/element-desktop/blob/develop/docs/windows-requirements.md)
|
||||
- [Windows pre-requisites](https://github.com/element-hq/element-web/blob/develop/apps/desktop/docs/windows-requirements.md)
|
||||
- Linux: TODO. Using the docker environment as above is recommended.
|
||||
- OS X: TODO
|
||||
|
||||
|
||||
@@ -13,16 +13,7 @@ Simply go to https://github.com/vector-im/element-desktop/actions/workflows/buil
|
||||
|
||||
## Packaging releases
|
||||
|
||||
**Don't do this for RCs! We don't build Element Desktop for RCs.**
|
||||
|
||||
For releasing Element Desktop, we assume the following prerequisites:
|
||||
|
||||
- a tag of `element-desktop` repo with the Element Desktop version to be released set in `package.json`.
|
||||
- an Element Web tarball published to GitHub with a matching version number.
|
||||
|
||||
**Both of these are done automatically when you run the release automation.**
|
||||
|
||||
The packaging is kicked off automagically for you when a Github Release for Element Desktop is published.
|
||||
The packaging is kicked off automagically for you when a Github Release for Element Web is published.
|
||||
|
||||
### More detail on the github actions
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ official element.io distribution, but these files may be useful if you want to
|
||||
inspect the configuration used there.
|
||||
|
||||
Element Desktop uses a separate config (see
|
||||
https://github.com/element-hq/element-desktop/tree/develop/element.io).
|
||||
https://github.com/element-hq/element-web/tree/develop/apps/desktop/element.io).
|
||||
|
||||
Deployment scripts (such as app/deploy.py) are meant to be run on the web server
|
||||
hosting the Element installation.
|
||||
|
||||
@@ -165,7 +165,7 @@ export default class EventIndexPanel extends React.Component<EmptyObject, IState
|
||||
);
|
||||
} else if (EventIndexPeg.platformHasSupport() && !EventIndexPeg.supportIsInstalled()) {
|
||||
const nativeLink =
|
||||
"https://github.com/vector-im/element-desktop/blob/develop/" +
|
||||
"https://github.com/element-hq/element-web/blob/develop/apps/desktop/" +
|
||||
"docs/native-node-modules.md#" +
|
||||
"adding-seshat-for-search-in-e2e-encrypted-rooms";
|
||||
|
||||
|
||||
+1
-1
@@ -62,7 +62,7 @@ exports[`<EventIndexPanel /> when event indexing is supported but not installed
|
||||
Element is missing some components required for securely caching encrypted messages locally. If you'd like to experiment with this feature, build a custom Element Desktop with
|
||||
<a
|
||||
class="mx_ExternalLink"
|
||||
href="https://github.com/vector-im/element-desktop/blob/develop/docs/native-node-modules.md#adding-seshat-for-search-in-e2e-encrypted-rooms"
|
||||
href="https://github.com/element-hq/element-web/blob/develop/apps/desktop/docs/native-node-modules.md#adding-seshat-for-search-in-e2e-encrypted-rooms"
|
||||
rel="noreferrer noopener"
|
||||
target="_blank"
|
||||
>
|
||||
|
||||
+1
-1
@@ -537,7 +537,7 @@ decentralised.
|
||||
|
||||
## Desktop app configuration
|
||||
|
||||
See https://github.com/element-hq/element-desktop#user-specified-configjson
|
||||
See https://github.com/element-hq/element-web/blob/develop/apps/desktop/README.md#user-specified-configjson
|
||||
|
||||
## UI Features
|
||||
|
||||
|
||||
@@ -64,9 +64,9 @@ The following lists a few common options.
|
||||
## Enabling by default on develop and nightly
|
||||
|
||||
Set the feature to `true` in the
|
||||
[develop](https://github.com/element-hq/element-web/blob/develop/element.io/develop/config.json)
|
||||
[develop](https://github.com/element-hq/element-web/blob/develop/apps/web/element.io/develop/config.json)
|
||||
and
|
||||
[nightly](https://github.com/element-hq/element-desktop/blob/develop/element.io/nightly/config.json)
|
||||
[nightly](https://github.com/element-hq/element-web/blob/develop/apps/desktop/element.io/nightly/config.json)
|
||||
configs:
|
||||
|
||||
```json
|
||||
@@ -78,9 +78,9 @@ configs:
|
||||
## Enabling by default on staging, app, and release
|
||||
|
||||
Set the feature to `true` in the
|
||||
[staging / app](https://github.com/element-hq/element-web/blob/develop/element.io/app/config.json)
|
||||
[staging / app](https://github.com/element-hq/element-web/blob/develop/apps/web/element.io/app/config.json)
|
||||
and
|
||||
[release](https://github.com/element-hq/element-desktop/blob/develop/element.io/release/config.json)
|
||||
[release](https://github.com/element-hq/element-web/blob/develop/apps/desktop/element.io/release/config.json)
|
||||
configs.
|
||||
|
||||
**Note:** The above will only enable the feature for https://app.element.io and official Element
|
||||
@@ -104,10 +104,10 @@ If the feature is meant to be forced on (non-configurable):
|
||||
2. Remove all `getValue` lines that test for the feature.
|
||||
3. Remove the feature from the [labs documentation](https://github.com/element-hq/element-web/blob/develop/docs/labs.md)
|
||||
4. If applicable, remove the feature state from
|
||||
[develop](https://github.com/element-hq/element-web/blob/develop/element.io/develop/config.json),
|
||||
[nightly](https://github.com/element-hq/element-desktop/blob/develop/element.io/nightly/config.json),
|
||||
[staging / app](https://github.com/element-hq/element-web/blob/develop/element.io/app/config.json),
|
||||
[develop](https://github.com/element-hq/element-web/blob/develop/apps/web/element.io/develop/config.json),
|
||||
[nightly](https://github.com/element-hq/element-web/blob/develop/apps/desktop/element.io/nightly/config.json),
|
||||
[staging / app](https://github.com/element-hq/element-web/blob/develop/apps/web/element.io/app/config.json),
|
||||
and
|
||||
[release](https://github.com/element-hq/element-desktop/blob/develop/element.io/release/config.json)
|
||||
[release](https://github.com/element-hq/element-web/blob/develop/apps/desktop/element.io/release/config.json)
|
||||
configs
|
||||
5. Celebrate! 🥳
|
||||
|
||||
@@ -1,3 +0,0 @@
|
||||
# Native Node Modules
|
||||
|
||||
This documentation moved to the [`element-desktop`](https://github.com/element-hq/element-desktop/blob/develop/docs/native-node-modules.md) repository.
|
||||
@@ -84,7 +84,6 @@ This label will automagically convert to `X-Release-Blocker` at the conclusion o
|
||||
|
||||
This release process revolves around our main repositories:
|
||||
|
||||
- [Element Desktop](https://github.com/element-hq/element-desktop/)
|
||||
- [Element Web](https://github.com/element-hq/element-web/)
|
||||
- [Matrix JS SDK](https://github.com/matrix-org/matrix-js-sdk/)
|
||||
|
||||
@@ -119,7 +118,6 @@ flowchart TD
|
||||
subgraph Releasing
|
||||
R1[[Releasing matrix-js-sdk]]
|
||||
R2[[Releasing element-web]]
|
||||
R3[[Releasing element-desktop]]
|
||||
|
||||
R1 --> R2 --> R3
|
||||
end
|
||||
@@ -204,12 +202,6 @@ switched back to the version of the dependency from the master branch to not lea
|
||||
- [ ] Make any changes to the release notes in the draft release as are necessary - **Do not click publish, only save draft**
|
||||
- [ ] Kick off a release using [the automation](https://github.com/element-hq/element-web/actions/workflows/release.yml) - making sure to select the right type of release. For anything other than an RC: choose final. You should not need to ever switch off either of the Publishing options.
|
||||
|
||||
### Element Desktop
|
||||
|
||||
- [ ] Check the draft release which has been generated by [the automation](https://github.com/element-hq/element-desktop/actions/workflows/release-drafter.yml)
|
||||
- [ ] Make any changes to the release notes in the draft release as are necessary - **Do not click publish, only save draft**
|
||||
- [ ] Kick off a release using [the automation](https://github.com/element-hq/element-desktop/actions/workflows/release.yml) - making sure to select the right type of release. For anything other than an RC: choose final. You should not need to ever switch off either of the Publishing options.
|
||||
|
||||
# Deploying
|
||||
|
||||
We ship the SDKs to npm, this happens as part of the release process.
|
||||
@@ -255,8 +247,6 @@ For the first RC of a given release cycle do these steps:
|
||||
|
||||
- [ ] Go to the [element-web Renovate dashboard](https://github.com/element-hq/element-web/issues/22941) and click the checkbox to create/update its PRs.
|
||||
|
||||
- [ ] Go to the [element-desktop Renovate dashboard](https://github.com/element-hq/element-desktop/issues/465) and click the checkbox to create/update its PRs.
|
||||
|
||||
- [ ] Later, check back and merge the PRs that succeeded to build. The ones that failed will get picked up by the [maintainer](https://docs.google.com/document/d/1V5VINWXATMpz9UBw4IKmVVB8aw3CxM0Jt7igtHnDfSk/edit#).
|
||||
|
||||
For final releases additionally do these steps:
|
||||
|
||||
Reference in New Issue
Block a user