Skip to content

Commit

Permalink
Add integrations and servers section. Also fix a typo
Browse files Browse the repository at this point in the history
  • Loading branch information
MTRNord committed Nov 21, 2024
1 parent 4967c0a commit 2070670
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,8 +177,41 @@ read_receipts = true

### Servers

Matrix Servers are listed in [`/content/ecosystem/servers/servers.toml`](https://github.com/matrix-org/matrix.org/blob/main/content/ecosystem/servers/servers.toml). Each entry is a new section in this toml file.

To add a server, add the following template to the end of the `servers.toml` and edit it according to your server

```toml
[[servers]]
name = "My Matrix Server"
description = "A Matrix server which can only reply status code 418"
author = "Your name or organisation"
maturity = "PICK ONE Stable OR Beta OR Alpha OR Obsolete"
language = "The programminglanguage of your server. For example 'Python'"
licence = "An spdx license code"
repository = "https://github.com/example-org/example-repo"
room = "#your-matrix-room:example.com"
```

### Integrations

Matrix integrations are listed in [`/content/ecosystem/integrations/integrations.toml`](https://github.com/matrix-org/matrix.org/blob/main/content/ecosystem/integrations/integrations.toml). A Matrix Integration can be for example a utility TUI but also Matrix Bots. Please see the description on the website itself to get a better feeling on the definition of Matrix Integrations.

To add an integration, add the following template to the end of the `integrations.toml` and edit the fields according to your integration

```toml
[[integrations]]
name = "My Matrix Integration"
description = "A brief description on which things it is able to do."
author = "Your name or organisation"
language = "The programminglanguage of your server. For example 'Python'"
licence = "An spdx license code"
repository = "https://github.com/example-org/example-repo"
room = "#your-matrix-room:example.com"
```

_Note that this section is due to further figuring out. See also <https://github.com/matrix-org/matrix.org/issues/1858>_

### SDKs

### Hosting providers
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The tools we have at our disposal are:

We try to keep a paper trail for all the decisions and implementation:

- All of the changes on the website nees to happen [through a Pull Request](https://github.com/matrix-org/matrix.org/pulls)
- All of the changes on the website need to happen [through a Pull Request](https://github.com/matrix-org/matrix.org/pulls)
- The only exception to this rules are if we broke things preventing our usual workflow.
- Pull Requests which do changes to existing content or add content outside of the blog should fix a documented and accepted [issue](https://github.com/matrix-org/matrix.org/pulls)
- Issues are reviewed by the maintainers of the project (@thibaultamartin and @MTRNord as of now). Some discussion can happen in [#matrix.org-website:matrix.org](https://matrix.to/#/%23matrix.org-website:matrix.org) but all decisions are logged in the issues themselves.
Expand Down

0 comments on commit 2070670

Please sign in to comment.