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

Added docs about escaping translations #639

Merged
merged 1 commit into from
Feb 13, 2020
Merged

Conversation

LukasHirt
Copy link
Collaborator

@LukasHirt LukasHirt commented Feb 13, 2020

image

@LukasHirt
Copy link
Collaborator Author

@C0rby for some reason I can't add you as a reviewer because it doesn't find you there 🤷‍♂ Pls check these docs as well 🙏

@PVince81
Copy link
Contributor

After reading the explanation it doesn't feel clear enough.

Wasn't this about avoiding double escaping ? Is the undesirable result the double escaping ? Might be good to be clear about this, because I usually shiver when I read disabling escaping for user controlled values. So we better make sure we are still on the safe side and say so explicitly (probably the thing about the mustache syntax)

@DeepDiver1975
Copy link
Member

Is this something for the design system? We have no translations in here and we are also not forcing any project on the tooling.

From my pov this needs to go into the docs for phoenix .... somewhere .....

@LukasHirt
Copy link
Collaborator Author

After reading the explanation it doesn't feel clear enough.

I'll try to go more into details 😉

@LukasHirt
Copy link
Collaborator Author

LukasHirt commented Feb 13, 2020

Is this something for the design system?

@DeepDiver1975 This was discussed recently and the reasoning behind this is to have the guidelines united as much as possible and since we are already including accessibility and design ones there (plus some internationalization already as well), seems ok to have there also parts about the actual code.

@LukasHirt LukasHirt force-pushed the docs/escaping-translations branch from dd65c99 to eafdbc0 Compare February 13, 2020 11:44
@LukasHirt
Copy link
Collaborator Author

@PVince81 Docs adjusted.

@PVince81
Copy link
Contributor

I also have mixed feelings about this but agree that having all in one place is slightly better.
Let's go with that for now.

@PVince81
Copy link
Contributor

thinking... adding the docs to Phoenix core will not help getting awareness for when we split Phoenix files and other extensions, as we'd need to duplicate the docs to these repos if they all use easygettext.

and some extensions might not use easygettext at all.

anyway, existing doc is better than no doc at all

Copy link
Contributor

@PVince81 PVince81 left a comment

Choose a reason for hiding this comment

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

👍

@PVince81 PVince81 merged commit 5383180 into master Feb 13, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs/escaping-translations branch February 13, 2020 12:59
@PVince81
Copy link
Contributor

raised #642

tboerger pushed a commit that referenced this pull request Feb 13, 2020
Merge: bdd3707 eafdbc0
Author: Vincent Petry <pvince81@owncloud.com>
Date:   Thu Feb 13 13:59:42 2020 +0100

    Merge pull request #639 from owncloud/docs/escaping-translations

    Added docs about escaping translations
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants