Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EZP-26829: Documented in-context translation usage #155

Merged
merged 2 commits into from
Jan 24, 2017

Conversation

bdunogier
Copy link
Member

Title says it all.

Copy link
Contributor

@yannickroger yannickroger left a comment

Choose a reason for hiding this comment

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

Good kickstart. I added comments that can be taken care of now or in a follow up.

addition, it integrates support for [in-context translation](in-context), a feature that
allows you to translate strings from the interface, _in context_.

![In-context translation of Platform UI](https://cloud.githubusercontent.com/assets/235928/21649816/44fc2ea0-d2a3-11e6-8c0e-1b5493ea47e9.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we store this screenshot along with the documentation?

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe, maybe not. @mere-teresa should confirm that, but storing images is one of the open questions when it comes to doc & github. Based on what I have seen, using images stored via pull-requests / issues is a viable way to do it, and it is simple. We can change it at some point indeed.

Copy link
Contributor

Choose a reason for hiding this comment

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

We should at some point as it kills the value of being able to read the documentation offline.

When moving over them, an edit button will show up on the top left corner of the outline.
Click on it, and edit the string in the window that shows up.

## Troubleshooting
Copy link
Contributor

Choose a reason for hiding this comment

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

You should add another paragraph explaining what is going to happen next. Like when the translations will actually be integrated in the product.

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'm not yet sure about that :)

Copy link
Contributor

Choose a reason for hiding this comment

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

This documentation page is not related to the translation in the project. It's only "how to use in-context-translation". I would not add the "next steps".


![In-context translation of Platform UI](https://cloud.githubusercontent.com/assets/235928/21649816/44fc2ea0-d2a3-11e6-8c0e-1b5493ea47e9.png)

## Toggling in-context translation
Copy link
Contributor

Choose a reason for hiding this comment

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

How does it work regarding the version used by the user. I mean 1.8.x or master etc.

Copy link
Member Author

Choose a reason for hiding this comment

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

Will work starting from the hash where this was merged to ezplatform. So from master of yesterday and 1.8.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

So the fact that the doc is there means the version is able to handle that :)

@bdunogier bdunogier force-pushed the i18n_in_context_doc branch from e670dff to a662054 Compare January 20, 2017 16:58
After adding this content to our Documentation on doc.ez.no, the Doc Squad did a Review and some changes were made in the text.
@bdunogier bdunogier merged commit 91e8290 into master Jan 24, 2017
@bdunogier bdunogier deleted the i18n_in_context_doc branch January 24, 2017 17:59
@bdunogier bdunogier changed the title EZP-26869: Documented in-context translation usage EZP-26829: Documented in-context translation usage Jan 24, 2017
andrerom pushed a commit that referenced this pull request Dec 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants