Skip to content
This repository was archived by the owner on Mar 27, 2023. It is now read-only.

Improve and document the configuration - #228

Open
feeds wants to merge 4 commits into
stagingfrom
config-doc
Open

feeds wants to merge 4 commits into
stagingfrom
config-doc

Conversation

@feeds

@feeds feeds commented Oct 4, 2020

Copy link
Copy Markdown
Collaborator

Small improvement of the configuration documentation (baby steps :))

Also, our app should not directly import "match4everything" for compatibility reasons, so we import the configuration from django.conf now

@feeds feeds added the xs label Oct 4, 2020

@bjrne bjrne left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems good, will test locally when complete. I like the separation of the apps :)

if B.profile_visible_for_participants_of_different_type:
if settings.PARTICIPANT_SETTINGS[
"B"
].profile_visible_for_participants_of_different_type:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very ugly formatting 🙈
I know its not your fault, it just looks awful.

Comment thread docs/configuration.rst

* ``name`` - the name with which this participant group should be referred to on the website itself

* ``properties`` - the list of properties that the participant type should be able to set on signup. The available properties are documented below.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A hyperlink could be useful in the finished PR ☺️

Suggested change
* ``properties`` - the list of properties that the participant type should be able to set on signup. The available properties are documented below.
* ``properties`` - the list of properties that the participant type should be able to set on signup. The available properties are documented below_.
.. _below: :ref:`configuration:properties`

@feeds
feeds marked this pull request as ready for review October 7, 2020 12:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants