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

Documentation improvements to contributing guide (#15667) #15668

Merged
merged 8 commits into from
May 26, 2023
Merged

Documentation improvements to contributing guide (#15667) #15668

merged 8 commits into from
May 26, 2023

Commits on May 25, 2023

  1. Documentation improvements to contributing guide (matrix-org#15667) 

    - Reiterate the importance of getting Rust installed and set up before
  attempting to install the Python dependencies.

- Mention the importance of confirming that `poetry install` completed
  successfully and include a typical error that the user might see if it
  did not.

- Expand on "Now edit homeserver.yaml" to give examples of things likely
  to need changing and to link to the relevant sections of the Synapse
  server documentation.

Signed-off-by: Grant McLean <grant@catalyst.net.nz>
    @grantm
    grantm committed May 25, 2023
    Configuration menu
    Copy the full SHA
    8b337a5 View commit details
    Browse the repository at this point in the history

  2. Add changelog

    @grantm
    grantm committed May 25, 2023
    Configuration menu
    Copy the full SHA
    0de548f View commit details
    Browse the repository at this point in the history

  3. Update docs/development/contributing_guide.md 

    Co-authored-by: Eric Eastwood <madlittlemods@gmail.com>
    @grantm @MadLittleMods
    grantm and MadLittleMods committed May 25, 2023
    Configuration menu
    Copy the full SHA
    c498fea View commit details
    Browse the repository at this point in the history

  4. Update docs/development/contributing_guide.md 

    Co-authored-by: Eric Eastwood <madlittlemods@gmail.com>
    @grantm @MadLittleMods
    grantm and MadLittleMods committed May 25, 2023
    Configuration menu
    Copy the full SHA
    74e9d28 View commit details
    Browse the repository at this point in the history

  5. Remove reference to editing log_config - not really necessary

    @grantm
    grantm committed May 25, 2023
    Configuration menu
    Copy the full SHA
    9552352 View commit details
    Browse the repository at this point in the history

  6. Moved mention of installing Rust to make it more obvious as a prerequ… 

    …isite
    @grantm
    grantm committed May 25, 2023
    Configuration menu
    Copy the full SHA
    af205f7 View commit details
    Browse the repository at this point in the history

  7. Remove mention of default Rust toolchain

    @grantm
    grantm committed May 25, 2023
    Configuration menu
    Copy the full SHA
    0b56baa View commit details
    Browse the repository at this point in the history

Commits on May 26, 2023

  1. Update changelog.d/15668.doc 

    Co-authored-by: Eric Eastwood <madlittlemods@gmail.com>
    @grantm @MadLittleMods
    grantm and MadLittleMods committed May 26, 2023
    Configuration menu
    Copy the full SHA
    782c51b View commit details
    Browse the repository at this point in the history