Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 54aa704

Browse files
authored
Removed page summaries from the top of installation and contributing doc pages (#10711)
- Removed page summaries from CONTRIBUTING and installation pages as this information was already in the table of contents on the right hand side - Fixed some broken links in CONTRIBUTING - Added margin-right tag for when table of contents is being shown (otherwise the text in the page sometimes overlaps with it)
1 parent 051ddac commit 54aa704

File tree

4 files changed

+21
-75
lines changed

4 files changed

+21
-75
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,6 @@ Welcome to Synapse
22

33
This document aims to get you started with contributing to this repo!
44

5-
- [1. Who can contribute to Synapse?](#1-who-can-contribute-to-synapse)
6-
- [2. What do I need?](#2-what-do-i-need)
7-
- [3. Get the source.](#3-get-the-source)
8-
- [4. Install the dependencies](#4-install-the-dependencies)
9-
* [Under Unix (macOS, Linux, BSD, ...)](#under-unix-macos-linux-bsd-)
10-
* [Under Windows](#under-windows)
11-
- [5. Get in touch.](#5-get-in-touch)
12-
- [6. Pick an issue.](#6-pick-an-issue)
13-
- [7. Turn coffee and documentation into code and documentation!](#7-turn-coffee-and-documentation-into-code-and-documentation)
14-
- [8. Test, test, test!](#8-test-test-test)
15-
* [Run the linters.](#run-the-linters)
16-
* [Run the unit tests.](#run-the-unit-tests-twisted-trial)
17-
* [Run the integration tests (SyTest).](#run-the-integration-tests-sytest)
18-
* [Run the integration tests (Complement).](#run-the-integration-tests-complement)
19-
- [9. Submit your patch.](#9-submit-your-patch)
20-
* [Changelog](#changelog)
21-
+ [How do I know what to call the changelog file before I create the PR?](#how-do-i-know-what-to-call-the-changelog-file-before-i-create-the-pr)
22-
+ [Debian changelog](#debian-changelog)
23-
* [Sign off](#sign-off)
24-
- [10. Turn feedback into better code.](#10-turn-feedback-into-better-code)
25-
- [11. Find a new issue.](#11-find-a-new-issue)
26-
- [Notes for maintainers on merging PRs etc](#notes-for-maintainers-on-merging-prs-etc)
27-
- [Conclusion](#conclusion)
28-
295
# 1. Who can contribute to Synapse?
306

317
Everyone is welcome to contribute code to [matrix.org
@@ -35,7 +11,7 @@ follow a simple 'inbound=outbound' model for contributions: the act of
3511
submitting an 'inbound' contribution means that the contributor agrees to
3612
license the code under the same terms as the project's overall 'outbound'
3713
license - in our case, this is almost always Apache Software License v2 (see
38-
[LICENSE](LICENSE)).
14+
[LICENSE](https://github.com/matrix-org/synapse/blob/develop/LICENSE)).
3915

4016
# 2. What do I need?
4117

@@ -98,17 +74,20 @@ to work on.
9874

9975
# 7. Turn coffee and documentation into code and documentation!
10076

101-
Synapse's code style is documented [here](docs/code_style.md). Please follow
102-
it, including the conventions for the [sample configuration
103-
file](docs/code_style.md#configuration-file-format).
77+
Synapse's code style is documented
78+
[here](https://matrix-org.github.io/synapse/develop/code_style.html).
79+
Please follow it, including the conventions for the
80+
[sample configuration file](https://matrix-org.github.io/synapse/develop/code_style.html#configuration-file-format).
10481

105-
There is a growing amount of documentation located in the [docs](docs)
82+
There is a growing amount of documentation located in the
83+
[docs](https://github.com/matrix-org/synapse/tree/develop/docs)
10684
directory. This documentation is intended primarily for sysadmins running their
107-
own Synapse instance, as well as developers interacting externally with
108-
Synapse. [docs/dev](docs/dev) exists primarily to house documentation for
109-
Synapse developers. [docs/admin_api](docs/admin_api) houses documentation
110-
regarding Synapse's Admin API, which is used mostly by sysadmins and external
111-
service developers.
85+
own Synapse instance, as well as developers interacting externally with Synapse.
86+
[docs/development](https://github.com/matrix-org/synapse/tree/develop/docs/development)
87+
exists primarily to house documentation for Synapse developers.
88+
[docs/admin_api](https://github.com/matrix-org/synapse/tree/develop/docs/admin_api)
89+
houses documentation regarding Synapse's Admin API, which is used mostly by sysadmins
90+
and external service developers.
11291

11392
If you add new files added to either of these folders, please use [GitHub-Flavoured
11493
Markdown](https://guides.github.com/features/mastering-markdown/).
@@ -431,7 +410,7 @@ By now, you know the drill!
431410
# Notes for maintainers on merging PRs etc
432411

433412
There are some notes for those with commit access to the project on how we
434-
manage git [here](docs/development/git.md).
413+
manage git [here](https://matrix-org.github.io/synapse/develop/development/git.html).
435414

436415
# Conclusion
437416

changelog.d/10711.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Removed table of contents from the top of installation and contributing documentation pages.

docs/setup/installation.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,5 @@
11
# Installation Instructions
22

3-
There are 3 steps to follow under **Installation Instructions**.
4-
5-
- [Installation Instructions](#installation-instructions)
6-
- [Choosing your server name](#choosing-your-server-name)
7-
- [Installing Synapse](#installing-synapse)
8-
- [Installing from source](#installing-from-source)
9-
- [Platform-specific prerequisites](#platform-specific-prerequisites)
10-
- [Debian/Ubuntu/Raspbian](#debianubunturaspbian)
11-
- [ArchLinux](#archlinux)
12-
- [CentOS/Fedora](#centosfedora)
13-
- [macOS](#macos)
14-
- [OpenSUSE](#opensuse)
15-
- [OpenBSD](#openbsd)
16-
- [Windows](#windows)
17-
- [Prebuilt packages](#prebuilt-packages)
18-
- [Docker images and Ansible playbooks](#docker-images-and-ansible-playbooks)
19-
- [Debian/Ubuntu](#debianubuntu)
20-
- [Matrix.org packages](#matrixorg-packages)
21-
- [Downstream Debian packages](#downstream-debian-packages)
22-
- [Downstream Ubuntu packages](#downstream-ubuntu-packages)
23-
- [Fedora](#fedora)
24-
- [OpenSUSE](#opensuse-1)
25-
- [SUSE Linux Enterprise Server](#suse-linux-enterprise-server)
26-
- [ArchLinux](#archlinux-1)
27-
- [Void Linux](#void-linux)
28-
- [FreeBSD](#freebsd)
29-
- [OpenBSD](#openbsd-1)
30-
- [NixOS](#nixos)
31-
- [Setting up Synapse](#setting-up-synapse)
32-
- [Using PostgreSQL](#using-postgresql)
33-
- [TLS certificates](#tls-certificates)
34-
- [Client Well-Known URI](#client-well-known-uri)
35-
- [Email](#email)
36-
- [Registering a user](#registering-a-user)
37-
- [Setting up a TURN server](#setting-up-a-turn-server)
38-
- [URL previews](#url-previews)
39-
- [Troubleshooting Installation](#troubleshooting-installation)
40-
41-
423
## Choosing your server name
434

445
It is important to choose the name for your server before you install Synapse,

docs/website_files/table-of-contents.css

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
:root {
2+
--pagetoc-width: 250px;
3+
}
4+
15
@media only screen and (max-width:1439px) {
26
.sidetoc {
37
display: none;
@@ -8,6 +12,7 @@
812
main {
913
position: relative;
1014
margin-left: 100px !important;
15+
margin-right: var(--pagetoc-width) !important;
1116
}
1217
.sidetoc {
1318
margin-left: auto;
@@ -18,7 +23,7 @@
1823
}
1924
.pagetoc {
2025
position: fixed;
21-
width: 250px;
26+
width: var(--pagetoc-width);
2227
overflow: auto;
2328
right: 20px;
2429
height: calc(100% - var(--menu-bar-height));

0 commit comments

Comments
 (0)