docs: suggesting translations in context for community projects (pitch tolgee/tolgee-platform#3780, scope E) - #1144
Open
Anty0 wants to merge 4 commits into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for in-context suggestions, scope E of pitch tolgee/tolgee-platform#3780 (community translation v2.0, SDK and browser plugin).
Held until the release. The feature is not released yet (platform tolgee/tolgee-platform#3930, SDK tolgee/tolgee-js#3539, browser plugin). Do not merge before those ship.
Depends on #1130. This PR targets
jirikuchynka/community-translations-docs, because the new owner page links into the Community Translation page added there. Merge #1130 first, then retarget this PR tomain.What it delivers
platform/projects_and_organizations/community_translation_in_context.mdxfor owners of public projects: what to configure in the project (public project,Suggestions mode) and on the website (apiUrlandprojectId, noapiKey, SDK kept up to date), what contributors need (Tolgee account and the Tolgee Tools plugin), and what they can and can't do in the dialog.js-sdk/in_context.mdx: new section "Suggest translations in context" (theSave/Suggest/Save & suggestbutton, what happens when one change fails, suggestions under each language with the actions per permission, the suggest-only dialog, troubleshooting including the plugin's reconnect prompt). Also a short subsection on signing in to the plugin with a Tolgee account instead of an API key, which the owner page depends on and which was not documented yet.suggestions.mdx: withSuggestions modeoff, the API now rejects new suggestions withsuggestions_disabled(HTTP 400) while existing ones stay manageable; deleting your own suggestion is a separate permission, also for API keys and connected applications.options.mdx:projectIdis also needed for plugin sign-in.Left out on purpose (optional in the pitch, undecided): in-context commenting, key description in the dialog, "Suggest instead".
Open before merge
The dialog UI was built in parallel, so these need a pass against what actually ships.
TODO_PLATFORM_VERSION: the minimum Tolgee platform version, in the owner page's "Prepare your project" and in the in-context troubleshooting. The dialog's ownMINIMAL_PLATFORM_VERSIONis deliberately left atv3.42.0, because every new field degrades on an older server rather than breaking, so the docs are the only place this requirement is stated.TODO_SDK_VERSION: the minimum@tolgee/webversion carrying suggestions in the dialog, in the in-context troubleshooting.grep -rn "TODO_SDK_VERSION\|TODO_PLATFORM_VERSION" platform js-sdkSave & suggestbutton; the suggest-only dialog; a partial-failure error on a field; the plugin popup withConnect to Tolgee; the advanced permissionsSuggestionsgroup with the delete-own rowSave/Suggest/Save & suggestReconnect to enable suggestions,Sign in again) against the released pluginChecked locally with
npm run build(broken links and anchors throw).https://docs.tolgee.io/translate-with-tolgee301s to the page on the deploy preview (the redirect lives instatic/_redirects;docusaurus serveignores that file, so it cannot be proven locally)_redirectsline and the two snippets