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

better documentation of template dirs #16372

Open
nerdoc opened this issue Sep 23, 2023 · 1 comment
Open

better documentation of template dirs #16372

nerdoc opened this issue Sep 23, 2023 · 1 comment
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.

Comments

@nerdoc
Copy link

nerdoc commented Sep 23, 2023

In e.g. the template docs for consent, there are the "template dirs" mentioned , but it is not said (from a newcomer perspective) where these template dirs are - the template docs tell me where to put them IMHO.

Given this yaml block...

user_consent:
  template_dir: privacy_policy_templates

...I would think that there must be a "privacy_policy_templates" directory within the custom user templates directory, with my config:

templates:
  custom_template_directory: "/home/myuser/synapse/templates/"

I have /home/myuser/synapse/templates/ and a /home/myuser/synapse/templates/privacy_policy_templates directories, and in the latter an en directory with a 1.0.html file.
But they are not found.

I think there is a misconfiguration, but the docs here are not clear IMHO.

@nerdoc
Copy link
Author

nerdoc commented Sep 23, 2023

One hint:

user_consent:
  template_dir: /absolute/path/to/privacy_policy_templates/

Then it works. I don't know if relative paths, in some way, work too. But this should be stated clearly.

@DMRobertson DMRobertson added A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements. labels Sep 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-Docs things relating to the documentation T-Enhancement New features, changes in functionality, improvements in performance, or user-facing enhancements.
Projects
None yet
Development

No branches or pull requests

2 participants