From e65f3f25ef38d9fc9ac83fbb4113e7fa36df55c7 Mon Sep 17 00:00:00 2001
From: Romain Bouvier <skunnyk@alteroot.org>
Date: Sun, 3 May 2020 21:51:26 +0200
Subject: [PATCH] Update README for Xfce

---
 README.md | 27 +++++++++++++++++----------
 1 file changed, 17 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index 6110dde..7b89d29 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ source ~/src/virtualenvs/bztogl/bin/activate
 # at this point your shell prompt will change to something like "(bztogl) $_"
 pip3 install python-bugzilla
 pip3 install python-gitlab
-pip3 install --user -e .
+pip3 install -e .
 # or use "python3 setup.py install --user" instead of the above
 ```
 
@@ -42,6 +42,7 @@ At a high level, `bztogl` needs to be able to do these:
 look at bugs that are already closed.*  Here, by "bugs that are open"
 we mean bugs with status `NEW, ASSIGNED, REOPENED, NEEDINFO,
 UNCONFIRMED`.
+You can migrate CLOSED/RESOLVED bugs with `--resolved` switch.
 
 # Know what you are doing
 
@@ -56,7 +57,7 @@ test project instead.
 
 1. Create a personal project for testing
 2. Get an API key
-3. Run `bztogl`
+3. Run `bztogl --xfce --production`
 
 Each of these steps is detailed below.
 
@@ -77,13 +78,14 @@ project there.
 key.  You can consider `bztogl` to be an application that wants to
 talk to Gitlab.
 
-If you are using gitlab-test.gnome.org, get an API key at
-https://gitlab-test.gnome.org/profile/personal_access_tokens — you can
-use "`bztogl`" for in the **Name** field of the application you want
-to register.  Pick an expiration date in the future, and **turn on**
-the checkboxes for **api** and **read_user**, so that `bztogl` can
-actually modify your test project.  Click on the "*Create personal
-access token*" button.
+You need to create an "admin" account for the migration, to be able to get all
+user informations (user email etc).
+Get an API key at https://gitlab.xfce.org/profile/personal_access_tokens
+ — you can use "`bztogl`" for in the **Name** field of the application you want
+**Turn on** the checkboxes for **api** and **read_user**, so that `bztogl` can
+actually modify your test project. Check **sudo** to be able to impersonate 
+a user during the migration.
+Click on the "*Create personal access token*" button.
 
 **WRITE DOWN THE API TOKEN** you get right after clicking that
 button.  You will not be able to see it again if you navigate away
@@ -99,9 +101,14 @@ virtualenv activated with the `activate` command form that example.
 Now you can run this:
 
 ```sh
-bztogl --token <your_api_token> --product myproject
+bztogl --xfce --token <your_api_token> --product Libxfce4util --target-project bugzilla-migration/libxfce4util
 ```
 
+Be aware that Xfce production on bugzilla start with an Uppercase!
+
+Using the `--production` switch will effectively do the migration ! So be sure to run it on a test `target-project`
+
+
 You will get some output:
 
 ```
-- 
GitLab