docs: document atlas language and directory map params #8
Conversation
openedx-webhooks
added
the
open-source-contribution
|
Thanks for the pull request, @OmarIthawi! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
OmarIthawi
changed the title
OmarIthawi
force-pushed
the
langs-param
branch
2 times, most recently
from
b1c40fc to
748d4ee
Compare
OmarIthawi
force-pushed
the
langs-param
branch
2 times, most recently
from
c068633 to
3b75f0a
Compare
OmarIthawi
force-pushed
the
langs-param
branch
3 times, most recently
from
59917f5 to
6a035a0
Compare
OmarIthawi
changed the title
OmarIthawi
force-pushed
the
langs-param
branch
2 times, most recently
from
df4cb4c to
10f9d0e
Compare
atlas
Outdated
| repository: <organization-name>/<repository-name> | ||
| branch: <branch-name> | ||
| directory: <repo-directory-name>:<local-dir-name> | ||
| filter: ar de fr_CA |
There was a problem hiding this comment.
The rest of the configuration file documentation here uses descriptions instead of examples. Maybe something like
| filter: ar de fr_CA | |
| filter: <lang-code> |
would work? The only issue I have with using <lang-code> is that the filter isn't technically language specific. I'm very open to other ideas for what to put here.
There was a problem hiding this comment.
Makes sense. Lang-code isn't what I prefer, but it's 99% of the time it'll just be that.
I added <pattern>. Please see the latest force-push update for the rest of the changes.
Document new params: - --filter - --directory arg replacement Refs: FC-0012 OEP-58
|
@OmarIthawi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description
This pull request is a documentation-only PR that I'll keep until all other PRs are merged. This helps to make incremental PRs faster while keeping documentation ready at the same time.
Documents new params:
Related PRs
This section is being updated to collect all related PRs:
References
This pull request is part of the FC-0012 project which is sparked by the Translation Infrastructure update OEP-58.
Check the links above for full information about the overall project.
Internalization is being rearchitected in Open edX Python, XBlock, Micro-frontend, and other projects. There are a number of immediately visible changes:
.json,.poor.mofiles will be committed into the repos.make extract_translationsin all repositories