Skip to content

add banner for non-english versions #381

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Nov 14, 2023
Merged

add banner for non-english versions #381

merged 4 commits into from
Nov 14, 2023

Conversation

PeterPetrik
Copy link
Contributor

We want to try to use Weglot for machine translations of the docs, we place small text for language mutations (e.g. on de.merginmaps.com/docs

fix #133

Screenshot 2023-11-02 at 16 31 02

cc @janpaulovic1 @mostlyAtNight

@PeterPetrik PeterPetrik requested a review from MarcelGeo November 2, 2023 15:33
@PeterPetrik
Copy link
Contributor Author

@MarcelGeo yarn dev works, but yarn build fails, how it is possible to get hostname in this static context?

[38](https://github.com/MerginMaps/docs/actions/runs/6734785848/job/18306442015#step:5:39)
[Vue warn]: Error in data(): "ReferenceError: window is not defined"

PeterPetrik and others added 2 commits November 2, 2023 16:39
@PeterPetrik
fix text
3334695
@MarcelGeo
Fix:
aba9fb9 
- getting window object after mount to browser
@MarcelGeo
Copy link
Contributor

I added targeting window object into mounted lifecycle method, which is called after append to DOM. Build is successfull on my machine . @PeterPetrik can you verify it?

@PeterPetrik
Copy link
Contributor Author

PeterPetrik commented Nov 3, 2023 •
edited
Loading

@MarcelGeo it is good, I have created new Weglot project for docs, they said we should insert this code before <head> tag, do you know how to do it?

<script type="text/javascript" src="https://cdn.weglot.com/weglot.min.js"></script>
<script>
    Weglot.initialize({
        api_key: 'wg_793fda6a46586055f8d5df5cc9fa6a270',
        hide_switcher: true
    });
</script>
  • also we may want to add dev.merginmaps.com to the list of hostnames without banner

For general approach I suggest (at least for beginning until we verify the quality of AI translations)
1/ on marketing web merginmaps.com we will have in menu link to ENGLISH version of docs (from ALL languages)
2/ on merginmaps.com/docs ENGLISH version, we will not have language switcher at all
3/ on .merginmaps.com/docs we will have banner that this is machine translated with link to ENGLISH version of the docs.

@MarcelGeo
Copy link
Contributor

@MarcelGeo it is good, I have created new Weglot project for docs, they said we should insert this code before <head> tag, do you know how to do it?

<script type="text/javascript" src="https://cdn.weglot.com/weglot.min.js"></script>
<script>
    Weglot.initialize({
        api_key: 'wg_793fda6a46586055f8d5df5cc9fa6a270',
        hide_switcher: true
    });
</script>

* also we may want to add dev.merginmaps.com to the list of hostnames without banner

For general approach I suggest (at least for beginning until we verify the quality of AI translations) 1/ on marketing web merginmaps.com we will have in menu link to ENGLISH version of docs (from ALL languages) 2/ on merginmaps.com/docs ENGLISH version, we will not have language switcher at all 3/ on .merginmaps.com/docs we will have banner that this is machine translated with link to ENGLISH version of the docs.

Do we want to display switcher in dev mode? @PeterPetrik

@PeterPetrik
Copy link
Contributor Author

PeterPetrik commented Nov 14, 2023 •
edited
Loading

Do we want to display switcher in dev mode? @PeterPetrik

@MarcelGeo no, I want to just show banner in sidebar on production and non-english version. I do not want to show switcher to other than English language anywhere.

@MarcelGeo
Added:
f29c58f 
- link to weglot in header
- logic for switching language
- allow translation for banner
@PeterPetrik PeterPetrik merged commit dade889 into main Nov 14, 2023
@PeterPetrik PeterPetrik deleted the i18n branch November 14, 2023 11:59
@PeterPetrik PeterPetrik restored the i18n branch November 15, 2023 06:13
@PeterPetrik PeterPetrik mentioned this pull request Nov 15, 2023
Merged
@PeterPetrik
Copy link
Contributor Author

There is a problem on Weglot side - I have reverted this

@PeterPetrik PeterPetrik mentioned this pull request Nov 15, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MarcelGeo MarcelGeo Awaiting requested review from MarcelGeo

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Translation/i18n support in the docs
2 participants
@PeterPetrik @MarcelGeo