Skip to content

Commit 0e4de67

Browse files
committed
add documentation on how to synchronize team profiles (#28)
1 parent 77d357b commit 0e4de67

File tree

4 files changed

+22
-7
lines changed

4 files changed

+22
-7
lines changed

com.sap.adt.abapcleaner.gui/src/com/sap/adt/abapcleaner/gui/FrmProfileDirs.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ public void widgetSelected(SelectionEvent e) {
125125
lblReadOnlyDirInfo.setText("You can specify up to 3 (typically synchronized) folders with team profiles which are used read-only.");
126126

127127
Label lblShortNameInfo = new Label(shell, SWT.NONE);
128-
lblShortNameInfo.setText("Please provide a short name for each folder (e.g. \"Team A\") for display in the profile list.");
128+
lblShortNameInfo.setText("Please provide a short name for each folder (e.g. \"team A\") for display in the profile list.");
129129

130130
Composite cpsReadOnlyDirs = new Composite(shell, SWT.NONE);
131131
GridData gd_cpsReadOnlyDirs = new GridData(SWT.FILL, SWT.CENTER, true, false, 1, 1);

com.sap.adt.abapcleaner.gui/src/com/sap/adt/abapcleaner/gui/FrmProfiles.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,7 @@ private class Highlighter {
145145
private final Color normalHighlightBackground;
146146
private final Color normalPasteExampleBackground;
147147
private final Color normalImportExportBackground;
148+
private final Color normalProfilesFolderBackground;
148149
private final Color normalLblFilterBackground;
149150
private final Color normalActivateBackground;
150151
private final Color normalHighlightDeclarationsBackground;
@@ -165,6 +166,7 @@ public Highlighter(Display display) {
165166
normalHighlightBackground = lblHighlight.getBackground();
166167
normalPasteExampleBackground = btnPasteExample.getBackground();
167168
normalImportExportBackground = btnImportProfile.getBackground();
169+
normalProfilesFolderBackground = btnChangeProfilesFolder.getBackground();
168170
normalLblFilterBackground = lblFilter.getBackground();
169171
normalActivateBackground = btnActivateDefaultRules.getBackground();
170172
normalHighlightDeclarationsBackground = chkHighlightDeclarationKeywords.getBackground();
@@ -194,7 +196,7 @@ public void setControlsHighlight(ProfileHighlightItem highlightItem) {
194196
setBackground(btnImportProfile, importExportBackground);
195197
setBackground(btnExportProfile, importExportBackground);
196198
setBackground(btnExportAllProfiles, importExportBackground);
197-
setBackground(btnChangeProfilesFolder, highlightItem.highlightFeatureOf(2023, 10, 3) ? newConfigBackground : normalImportExportBackground); // first highlight on (2023, 3, 9)
199+
setBackground(btnChangeProfilesFolder, highlightItem.highlightFeatureOf(2023, 10, 3) ? newConfigBackground : normalProfilesFolderBackground); // first highlight on (2023, 3, 9)
198200

199201
setBackground(lblFilter, highlightItem.highlightFeatureOf(2023, 3, 9) ? newConfigBackground : normalLblFilterBackground);
200202

27.6 KB
Loading

docs/profiles.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,25 @@ All profiles can be deleted (except the last remaining one).
2929
For instance, you may want to configure a standard profile in which all rules are activated that you agree to use,
3030
and several special profiles for specific cleanup tasks, in which only one or very few rules are activated.
3131

32-
To pass on profiles to colleagues, you may use the '**Export...**' or '**Export All...**' buttons
32+
### Sharing and synchronizing profiles with colleagues
33+
34+
To **quickly pass on profiles** to colleagues, you may use the '**Export...**' or '**Export All...**' buttons
3335
and send the exported .cfj file(s) to your colleagues, who could then '**Import...**' them.
34-
To change the local profiles folder (e.g. to a synchronized folder), click '**Folder...**' and select the new folder.
35-
Existing profiles will be moved to the newly selected folder.
36-
Direct access to the local profiles folder (by default, %APPDATA%\SAP\ABAP cleaner\user\profiles)
37-
is possible from the [main screen](main-window.md) with the menu 'Help / Open Profiles Folder'.
36+
Direct access to the local profiles folder is possible from the [main screen](main-window.md)
37+
with the menu 'Help / Open Profiles Folder'.
38+
39+
If your team wants to share and **continually synchronize profiles**,
40+
* your team architect or lead developer may configure a profile as needed
41+
and use the '**Export...**' button to store it on a synchronized folder (e.g. on OneDrive).
42+
* Team members can then use the '**Folders...**' button to add this synchronized folder
43+
as an additional read-only source of **Team Profiles**:
44+
45+
![ABAP cleaner profiles and rules - profile folders](images/profiles_profile-folders.png "ABAP cleaner profiles and rules - profile folders")
46+
47+
Team profiles then appear as 'team A: default' etc. in the profile list and can be selected and used, but not modified.
48+
49+
* After changing the configuration of a profile, the team architect or lead developer can simply export it again,
50+
overwriting it in the synchronized folder and thus updating it for everyone.
3851

3952

4053
### Profile settings

0 commit comments

Comments
 (0)