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

Docs on consent bits #3268

Merged
merged 10 commits into from
May 23, 2018
Merged

Docs on consent bits #3268

merged 10 commits into from
May 23, 2018

Conversation

richvdh
Copy link
Member

@richvdh richvdh commented May 23, 2018

No description provided.

neilisfragile
neilisfragile reviewed May 23, 2018
View reviewed changes
docs/consent_tracking.md
To enable this, first create templates for the policy and success pages.
These should be stored on the local filesystem.

These templates use the [Jinja2](http://jinja.pocoo.org) templating language,
Copy link
Contributor

Choose a reason for hiding this comment

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

I found it hard to parse this section, perhaps
"These templates use the Jinja2 templating language, and docs/privacy_policy_templates gives examples of the sort of thing that can be done.''

Copy link
Member Author

Choose a reason for hiding this comment

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

I suspect it's not in docs if you've got a debian installation :/

Copy link
Member Author

Choose a reason for hiding this comment

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

ok, should be better now

neilisfragile
neilisfragile reviewed May 23, 2018
View reviewed changes
docs/consent_tracking.md


Finally, ensure that `jinja2` is installed. If you are using a virtualenv, this
should be a matter of `pip install Jinja2`. On debian, try `apt-get install
Copy link
Contributor

Choose a reason for hiding this comment

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

Why is jinja2 a special cased dependency?

Copy link
Member Author

Choose a reason for hiding this comment

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

well, because if you aren't doing this sort of stuff, you don't need it. Though maybe we should reconsider this.

neilisfragile
neilisfragile reviewed May 23, 2018
View reviewed changes
docs/consent_tracking.md Outdated
python-jinja2`.

Once this is complete, and the server has been restarted, try visiting
`https://<server>/_matrix/consent`. If configuration has been done correctly,
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe "If correctly configured this should give an error...."

Copy link
Member Author

Choose a reason for hiding this comment

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

done

neilisfragile
neilisfragile reviewed May 23, 2018
View reviewed changes
docs/server_notices.md Outdated
'Server Notices' are a new feature introduced in Synapse 0.30. They provide a
channel whereby server administrators can send messages to users on the server.

They are used as part of the communication of the server polices (see
Copy link
Contributor

Choose a reason for hiding this comment

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

drop the 'the'?

Copy link
Member Author

Choose a reason for hiding this comment

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

"part of communication of the server polices" ? really?

"part of communicating" maybe?

neilisfragile
neilisfragile reviewed May 23, 2018
View reviewed changes
docs/server_notices.md Outdated
Server notices come from a specific user id on the server. Server
administrators are free to choose the user id - something like `server` is
suggested, meaning the notices will come from
`@server:<your_server_name>`. Once the server notices user is configured, that
Copy link
Contributor

Choose a reason for hiding this comment

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

Easy to misinterpret as the server noticing something - at first I thought it was a typo. Perhaps capitalise Server Notices User?

Copy link
Member Author

Choose a reason for hiding this comment

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

good point, done

neilisfragile
neilisfragile suggested changes May 23, 2018
View reviewed changes
Copy link
Contributor

@neilisfragile neilisfragile left a comment

Choose a reason for hiding this comment

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

Small suggestions for clarity otherwise LGTM

@richvdh richvdh assigned neilisfragile and unassigned richvdh May 23, 2018
neilisfragile
neilisfragile approved these changes May 23, 2018
View reviewed changes
Copy link
Contributor

@neilisfragile neilisfragile left a comment

Choose a reason for hiding this comment

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

lgtm

@richvdh richvdh merged commit 96f07ce into develop May 23, 2018
richvdh added a commit that referenced this pull request May 23, 2018
@richvdh
Merge docs on consent bits from PR #3268 into release branch
043f05a
neilisfragile added a commit that referenced this pull request Jun 6, 2018
@neilisfragile
Merge tag 'v0.31.0'
752b7b3 
Changes in synapse v0.31.0 (2018-06-06)
======================================

Most notable change from v0.30.0 is to switch to python prometheus library to improve system
stats reporting. WARNING this changes a number of prometheus metrics in a
backwards-incompatible manner. For more details, see
`docs/metrics-howto.rst <docs/metrics-howto.rst#removal-of-deprecated-metrics--time-based-counters-becoming-histograms-in-0310>`_.

Bug Fixes:

* Fix metric documentation tables (PR #3341)
* Fix LaterGuage error handling (694968f)
* Fix replication metrics (b7e7fd2)

Changes in synapse v0.31.0-rc1 (2018-06-04)
==========================================

Features:

* Switch to the Python Prometheus library (PR #3256, #3274)
* Let users leave the server notice room after joining (PR #3287)

Changes:

* daily user type phone home stats (PR #3264)
* Use iter* methods for _filter_events_for_server (PR #3267)
* Docs on consent bits (PR #3268)
* Remove users from user directory on deactivate (PR #3277)
* Avoid sending consent notice to guest users (PR #3288)
* disable CPUMetrics if no /proc/self/stat (PR #3299)
* Add local and loopback IPv6 addresses to url_preview_ip_range_blacklist (PR #3312) Thanks to @thegcat!
* Consistently use six's iteritems and wrap lazy keys/values in list() if they're not meant to be lazy (PR #3307)
* Add private IPv6 addresses to example config for url preview blacklist (PR #3317) Thanks to @thegcat!
* Reduce stuck read-receipts: ignore depth when updating (PR #3318)
* Put python's logs into Trial when running unit tests (PR #3319)

Changes, python 3 migration:

* Replace some more comparisons with six (PR #3243) Thanks to @NotAFile!
* replace some iteritems with six (PR #3244) Thanks to @NotAFile!
* Add batch_iter to utils (PR #3245) Thanks to @NotAFile!
* use repr, not str (PR #3246) Thanks to @NotAFile!
* Misc Python3 fixes (PR #3247) Thanks to @NotAFile!
* Py3 storage/_base.py (PR #3278) Thanks to @NotAFile!
* more six iteritems (PR #3279) Thanks to @NotAFile!
* More Misc. py3 fixes (PR #3280) Thanks to @NotAFile!
* remaining isintance fixes (PR #3281) Thanks to @NotAFile!
* py3-ize state.py (PR #3283) Thanks to @NotAFile!
* extend tox testing for py3 to avoid regressions (PR #3302) Thanks to @krombel!
* use memoryview in py3 (PR #3303) Thanks to @NotAFile!

Bugs:

* Fix federation backfill bugs (PR #3261)
* federation: fix LaterGauge usage (PR #3328) Thanks to @intelfx!
@richvdh richvdh deleted the rav/privacy_policy_docs branch July 10, 2018 12:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@neilisfragile neilisfragile neilisfragile approved these changes

Assignees

@neilisfragile neilisfragile

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@richvdh @neilisfragile