Add a clarification for the public_baseurl property.

[zblesk]

I have been a bit confused about the correct way to set the public_baseurl and did it wrong. I've realized the mistake with some help from the folks in #synapse:matrix.org and they suggested I try and add a clarification to the sample file. So that's what I'm trying to do.

Signed-off-by: Ladislav Benc ladislav.benc@protonmail.com

[clokep]

@zblesk Can you make the corresponding change in synapse/config/server.py to make CI happy? Thanks!

[zblesk]

Well. I tried updating until it stopped complainng about mismatches and trailing spaces; now it says No new newsfragments found on this branch. and I have no idea what that means, sorry.

[clokep]

@zblesk Please take a look at the contributing guide: https://github.com/matrix-org/synapse/blob/develop/CONTRIBUTING.md#changelog

[richvdh]

thank you for contributing!

Honestly though, I'm not sure this adds any clarity to what's there already. Doesn't it just repeat the existing description?

existing:

this should be the URL to reach synapse [via the proxy]

new:

this URL should point to Synapse itself.

... those are basically the same, no?

I realise it's confusing, but I don't think that saying the same thing over and over is going to help.

Unfortunately, I don't really have any better suggestions here :/

[zblesk]

As mentioned above, I'm only doing this because gus in the #synapse channel asked me to, after I got stuck on this point. I do not have any improvements for this.
If it doesn't fit, feel free to close this PR.

[clokep]

Thanks for your contribution. I'm going to close this per @richvdh's comment above.