add: 1 FAQ question to pontoon docs

This commit is contained in:
flx-sta 2024-09-23 08:36:36 -07:00
parent 186c3a27a5
commit 0b1daf4f0b

View File

@ -5,7 +5,8 @@
Follow the [Developer Setup](https://mozilla-pontoon.readthedocs.io/en/latest/dev/setup.html) guide. Follow the [Developer Setup](https://mozilla-pontoon.readthedocs.io/en/latest/dev/setup.html) guide.
<sub>Prerequisites & Quickstart copy from 2024-09-13</sub> <details>
<summary>"Prerequisites & Quickstart" copy from 2024-09-13</summary>
> Prerequisites > Prerequisites
> ------------- > -------------
@ -73,12 +74,14 @@ Follow the [Developer Setup](https://mozilla-pontoon.readthedocs.io/en/latest/de
> The app should now be available at http://localhost:8000 or the custom SITE_URL. > The app should now be available at http://localhost:8000 or the custom SITE_URL.
> >
> And with that, you're ready to start :doc:`contributing`! > And with that, you're ready to start :doc:`contributing`!
</details>
## Adding You Project to Pontoon ## Adding You Project to Pontoon
Follow the [Adding a new project to Pontoon](https://mozilla-pontoon.readthedocs.io/en/latest/user/localizing-your-projects.html#adding-a-new-project-to-pontoon) guide Follow the [Adding a new project to Pontoon](https://mozilla-pontoon.readthedocs.io/en/latest/user/localizing-your-projects.html#adding-a-new-project-to-pontoon) guide
<sub>Copy from 2024-09-13</sub> <details>
<summary>"Adding a new project to Pontoon" copy from 2024-09-13</summary>
> Adding a new project to Pontoon > Adding a new project to Pontoon
> ------------------------------- > -------------------------------
@ -116,6 +119,7 @@ Follow the [Adding a new project to Pontoon](https://mozilla-pontoon.readthedocs
> >
> .. _new project documentation: https://mozilla-l10n.github.io/documentation/tools/pontoon/adding_new_project.html > .. _new project documentation: https://mozilla-l10n.github.io/documentation/tools/pontoon/adding_new_project.html
> .. _start localizing your project: https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/ > .. _start localizing your project: https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/
</details>
### Data Source example ### Data Source example
@ -173,3 +177,30 @@ I still havent figured this part fully out but you have to use the django admin
## Sync Process ## Sync Process
See [sync/README.md](https://github.com/mozilla/pontoon/blob/main/pontoon/sync/README.md) See [sync/README.md](https://github.com/mozilla/pontoon/blob/main/pontoon/sync/README.md)
# FAQ
- ### Q: What if a file is renamed/moved?
- #### A: Refer to the [Renaming a localization file in a project without losing data](https://mozilla-l10n.github.io/documentation/tools/pontoon/renaming_a_file.html) documentation page.
<details>
<summary>"Renaming a localization file in a project without losing data" copy from 2024-09-23</summary>
> # Renaming a localization file in a project without losing data
>
> In some cases, project owners will want to rename a file for clarity, or for technical reasons. If its only done in the VCS > repository, the file will be imported again and you will lose attribution, pending suggestions and history. Since this is a special > case, we can work around this and rename the file in Pontoon while keeping existing data (translations, suggestions, attribution, > history). The process is not complicated, but it has to be highly coordinated.
>
> ## Get a Pull Request ready
>
> Either you or the project owners will get a Pull Request ready that renames the file for all locales. Using a script is recommended > as you will need to generate the patch not too long before the next steps to avoid conflicts.
>
> ## Rename the resource in Pontoon admin panel
>
> Wait for the current Pontoon sync cycle to end, and make sure you are already logged into Pontoon admin, then merge the Pull Request.
>
> As soon as the Pull Request is merged, go to the [resource section](https://pontoon.mozilla.org/a/base/resource/) of the admin > panel, then type the name of your project (e.g. `thimble`) and hit `Enter`. All the resources for your project should appear. Click > on the one you want to rename, and in the `path` field, for instance rename `messages.properties` into `server.properties` then > click `SAVE`.
>
> It is crucial to do this step **before** the next sync cycle, otherwise the process wont be effective.
>
> After the next sync, open the file for one of the locales, you should be able to see all the existing data.
</details>