Introduce separate translations for API documentation #733
Conversation
newstler
changed the title
| @@ -146,5 +146,103 @@ namespace :bullet_train do | |||
| ) | |||
| end | |||
| end | |||
|
|
|||
| desc "Create `api_title` and `api_description` translations" | |||
| task create_translations: :environment do | |||
There was a problem hiding this comment.
@newstler Is this a task that's intended to be used by end users/developers? If so, we should probably document it somewhere. And maybe mention in the PR description that people should run it?
There was a problem hiding this comment.
Right, sure. Where do we usually document such things?
There was a problem hiding this comment.
I don't exactly know. Why and when would people need to use it? Maybe that can help us figure out where to surface it.
There was a problem hiding this comment.
They only need to run it once, to update all the old translations they have. As there is no documentation for the bt-api gem, probably there should be a post-install massage? I have some thoughts about bt-api README, but right now seems post-install message should work just fine, I'll try to add it.
There was a problem hiding this comment.
To be honest I would even run this task automatically after gem install, do you think this is an acceptable approach?
There was a problem hiding this comment.
I'm not a huge fan of the idea of running it automatically. Maybe if it's extremely fast to run. But otherwise it's going to be taking time every time someone runs bundle install whether locally or in CI/CD.
I think a post-install message would be better than automatically running.
There was a problem hiding this comment.
Added post-install message in bullet_train-api/bullet_train-api.gemspec.
I will try to create README for bt-api in a separate PR soon, and will mention this (and other) rake tasks there.
This PR introduces separate translations for API:
api_titleandapi_description. Those are to be used in OpenAPI documentation without affection of the UI.bullet_train:api:create_translationswhich updates existing locale files, and creates backup translation files intmp/backup_localesif the original file was updated.