docs: add CLI FAQ and document key management limitations #996
Conversation
✅ Deploy Preview for tolgee-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
tolgee-cli/faq.mdx
Outdated
| **A: This depends on your approach to translation management.** | ||
|
|
||
| If you follow Tolgee's recommended approach of using the platform as the single source of truth: | ||
| - You would search for keys in your code: `grep -r "save-btn" src/` |
There was a problem hiding this comment.
Yoi don't need to search for the key usually, because you can click it directly in the app. So the correct approach is to click the string in the app and then search for the key.
There was a problem hiding this comment.
Since this is tle CLI docs, you should mention that in-context is only for the native JS SDKs.
tolgee-cli/faq.mdx
Outdated
| - A translator or PM has already refined the wording in the platform | ||
| - The two sources of truth conflict with each other | ||
|
|
||
| ### Q: Can I search for strings in my code if I only store keys? |
There was a problem hiding this comment.
How can I search for strings in my code if I only use keys and not default values?
tolgee-cli/faq.mdx
Outdated
|
|
||
| ### Q: What about fallback translations for when the platform is unavailable? | ||
|
|
||
| **A: Use the pull command to maintain local fallback files.** |
There was a problem hiding this comment.
You should NEVER use API key in the production. For production, you have 2 options:
- Exporting keys as static assets
- using CDN
Don't know what support question you cover by this, but now it's misleading, because it seems like you should rely on platform in production, which you should never do.
tolgee-cli/faq.mdx
Outdated
|
|
||
| **A: This is a known limitation that may be addressed in future versions.** | ||
|
|
||
| Currently, the CLI focuses on extracting keys and syncing with the platform. Enhanced validation features like duplicate detection are being considered for future releases. |
There was a problem hiding this comment.
I am confused about this "duplicate detection". Usually people mean that they don't want to transalte same phrases twice. They don't want multiple keys containing same string.
But we usually recommend agains de-duplication, since same strings can have multiple meanings and you want to be able to change it just in single place where it's used.
dzienisz
force-pushed
the
feat/cli-limitations
branch
from
43fc628 to
3ad3ca2
Compare
…ey best practices
No description provided.