From 0b1daf4f0bf7ac1c009201687c8095b54536de36 Mon Sep 17 00:00:00 2001
From: flx-sta <50131232+flx-sta@users.noreply.github.com>
Date: Mon, 23 Sep 2024 08:36:36 -0700
Subject: [PATCH] add: 1 FAQ question to pontoon docs
---
docs/pontoon-setup.md | 37 ++++++++++++++++++++++++++++++++++---
1 file changed, 34 insertions(+), 3 deletions(-)
diff --git a/docs/pontoon-setup.md b/docs/pontoon-setup.md
index f3ee537ecdb..7bd0a1e8ebe 100644
--- a/docs/pontoon-setup.md
+++ b/docs/pontoon-setup.md
@@ -5,7 +5,8 @@
Follow the [Developer Setup](https://mozilla-pontoon.readthedocs.io/en/latest/dev/setup.html) guide.
-Prerequisites & Quickstart copy from 2024-09-13
+
+ "Prerequisites & Quickstart" copy from 2024-09-13
> 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.
>
> And with that, you're ready to start :doc:`contributing`!
+
## 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
-Copy from 2024-09-13
+
+ "Adding a new project to Pontoon" copy from 2024-09-13
> 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
> .. _start localizing your project: https://mozilla-l10n.github.io/localizer-documentation/tools/pontoon/
+
### Data Source example
@@ -172,4 +176,31 @@ I still havent figured this part fully out but you have to use the django admin
## Sync Process
-See [sync/README.md](https://github.com/mozilla/pontoon/blob/main/pontoon/sync/README.md)
\ No newline at end of file
+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.
+
+ "Renaming a localization file in a project without losing data" copy from 2024-09-23
+
+ > # 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 it’s 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 won’t be effective.
+ >
+ > After the next sync, open the file for one of the locales, you should be able to see all the existing data.
+
+