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

Improve contributor docs with reference to Rust #15667

Closed
grantm opened this issue May 25, 2023 · 1 comment · Fixed by #15668
Closed

Improve contributor docs with reference to Rust #15667

grantm opened this issue May 25, 2023 · 1 comment · Fixed by #15668
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. Z-Dev-Wishlist Makes developers' lives better, but doesn't have direct user impact

Comments

@grantm
Copy link
Contributor

grantm commented May 25, 2023

Description

I ran into trouble setting up a development environment but following the docs in develop/docs/development/contributing_guide.md. Admittedly the problems were due to poor reading comprehension on my part, but some clarifications in the documentation might help.

Steps to reproduce

  • Skim the documentation and completely fail to see the mention of Rust
  • Run poetry install and watch it fail due to needing Rust
  • Fix some things, but fail to get a clean run of poetry install

Homeserver

Local development environment

Synapse Version

1.84.0rc1 (b=develop,1903c7e5e)

Installation Method

pip (from PyPI)

Database

A single PostgreSQL server, with a new clean DB

Workers

Single process

Platform

Development environment running directly in the host OS (no VM or container) on Ubuntu 20.04

Configuration

No unusual configs

Relevant log output

$ poetry run python -m synapse.app.homeserver -c homeserver.yaml
Traceback (most recent call last):
  File "/usr/lib/python3.8/runpy.py", line 185, in _run_module_as_main
    mod_name, mod_spec, code = _get_module_details(mod_name, _Error)
  File "/usr/lib/python3.8/runpy.py", line 111, in _get_module_details
    __import__(pkg_name)
  File "/home/grant/projects/synapse/synapse/app/__init__.py", line 18, in <module>
    from synapse.util import check_dependencies
  File "/home/grant/projects/synapse/synapse/util/check_dependencies.py", line 58, in <module>
    set(metadata.metadata(DISTRIBUTION_NAME).get_all("Provides-Extra")) - DEV_EXTRAS
  File "/usr/lib/python3.8/importlib/metadata.py", line 520, in metadata
    return Distribution.from_name(distribution_name).metadata
  File "/usr/lib/python3.8/importlib/metadata.py", line 177, in from_name
    raise PackageNotFoundError(name)
importlib.metadata.PackageNotFoundError: matrix-synapse

Anything else that would be useful to know?

I have the makings of a pull request here:

https://github.com/grantm/synapse/tree/grantm/contributor-docs
grantm added a commit to grantm/synapse that referenced this issue May 25, 2023
@grantm
Documentation improvements to contributing guide (matrix-org#15667)
6c9b5c9 
- 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.
@MadLittleMods MadLittleMods added A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. Z-Dev-Wishlist Makes developers' lives better, but doesn't have direct user impact labels May 25, 2023
grantm added a commit to grantm/synapse that referenced this issue May 25, 2023
@grantm
Documentation improvements to contributing guide (matrix-org#15667)
8b337a5 
- 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>
@reivilibre
Copy link
Contributor

Please do submit a PR with that, it looks good at a glance!

@reivilibre reivilibre linked a pull request May 25, 2023 that will close this issue
Documentation improvements to contributing guide (#15667) #15668
Merged
4 tasks
@MadLittleMods MadLittleMods mentioned this issue May 25, 2023
Merged
4 tasks
MadLittleMods pushed a commit that referenced this issue May 26, 2023
@grantm
Documentation improvements to contributing guide (#15667) (#15668)
179f0f8 
Fix #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.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. Z-Dev-Wishlist Makes developers' lives better, but doesn't have direct user impact
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Documentation improvements to contributing guide (#15667) grantm/synapse
3 participants
@grantm @MadLittleMods @reivilibre