Skip to content

Commit 88966fe

Browse files
authored
Merge pull request mendix#10443 from tknippenberg/HistoryPane
Updated History documentation for 11.6 Pane GA
2 parents 32f3227 + d2849f4 commit 88966fe

8 files changed

Lines changed: 46 additions & 43 deletions

File tree

content/en/docs/refguide/modeling/menus/edit-menu/preferences-dialog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,6 +161,10 @@ This is the pattern from which the arguments are derived that are passed to the
161161
* `{0}` – this is replaced with the name of the original file before the arguments are passed to the file comparison program
162162
* `{1}` – this is replaced with the name of the changed file before the arguments are passed to the file comparison program
163163

164+
#### History {#history-pane}
165+
166+
Select this option to use the blocking History dialog instead of the non-blocking, searchable History pane.
167+
164168
#### Solution Warning
165169

166170
Select **Show warning on updating marketplace modules** to display a warning message when updating a Marketplace module.

content/en/docs/refguide/modeling/menus/version-control-menu/history-dialog.md

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -5,93 +5,92 @@ weight: 50
55
---
66
## Introduction
77

8-
Use the **History** dialog box to look at all the changes that have been committed to a development line of an app. You can open this dialog box from the **Version Control** > **History…** menu item. This dialog box is also used when selecting a revision to merge from, create a branch line off, or to create a deployment archive from.
8+
Use the **History** pane to see the changes that have been committed to a development line of an app. You can open this pane from the **Version Control** > **History…** menu item. The **History** pane displays all revisions at once in a searchable grid, making it easy to view the detailed project history.
99

1010
{{% alert color="info" %}}
11-
In Studio Pro 11.4, the non-blocking, searchable **History** pane beta has been released. Open the pane by clicking **View** > **History**. You can set this feature as your default history view in the Preferences [New Features](/refguide/preferences-dialog/#history-pane) tab.
12-
{{% /alert %}}
11+
In Studio Pro 11.6, a new default view for History was introduced. Partially-cloned apps automatically get the older blocking dialog and through the [Version Control Preferences](/refguide/preferences-dialog/#history-pane), you can choose to keep using the blocking dialog for all apps.
1312

14-
{{% alert color="info" %}}
15-
The **History** pane is not available when the app is partially cloned.
16-
{{% /alert %}}
13+
When using the Revision Selector to select a revision to revert, to merge from, create a branch line off, or to create a deployment archive from, the blocking dialog is still used.
1714

18-
The **History** dialog can display up to 250 commits at once, making it easy to look at the detailed project history. If the app was only partially copied, it may need to download missing data from the server. While the data is being downloaded, a progress bar will be shown. This initial download could take a little time, but once the data is saved locally, future access to the **History** dialog will be significantly faster — almost instant.
15+
For more information on the blocking dialog, refer to the [Mendix 10 documentation](/refguide10/history-dialog/).
16+
{{% /alert %}}
1917

2018
## Revisions
2119

2220
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" alt="Revisions Image" class="no-border" >}}
2321

24-
Each line in the grid represents a revision in the repository. For each revision the following information is shown, more information about each of these values is available below:
22+
Each line in the grid represents a revision in the repository.
23+
24+
### Search and Filters
25+
26+
There are different filter options available to help find specific revisions:
27+
28+
* The search bar looks in all fields of the revisions grid and in the details of the commit, such as the Model changes, Disk changes and Stories.
29+
* The date filter allows specifying a date range for revisions. The available presets help to quickly select a range.
30+
* The document filter allows selecting a document, such as a specific microflow, to filter all revisions on.
31+
32+
### Content
33+
34+
For each revision the following information is shown, more information about each of these values is available below:
2535

2636
* [Revision](#revision)
27-
* [Changes](#changes)
37+
* [Status](#status)
2838
* [Author](#author)
29-
* [Date](#date)
30-
* [Time](#time)
39+
* [Date/Time](#datetime)
3140
* [Message](#message)
3241

3342
By selecting a revision in this grid, the tabs below the grid will be filled with information about this revision.
3443

35-
### Revision{#revision}
44+
#### Revision{#revision}
3645

3746
A unique alphanumeric identifier of the revision in the repository. The revision identifier is the Git hash for the commit and is unique for a whole repository.
3847

39-
### Changes{#changes}
48+
#### Status{#status}
4049

41-
A visual summary of the changes in the selected revision, each icon represents different type of change:
50+
Shows the state of the revision in relation to the server. It can have one of the following values:
4251

43-
| Icon | Change Type | Notes |
44-
| --- | --- | --- |
45-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/MergeRevision.png" width=32 alt="Merge commit icon" class="no-border" >}} | Merge commit | Indicates that the commit is a merge of two different commits.<br/>Hovering over will show both the parent [revisions](#revision). |
46-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesModel.png" width=32 alt="Model changes icon" class="no-border" >}} | Model changes | Indicates that there were some changes made to the app model.<br/>For example, changes to the domain model, microflows, or pages. |
47-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesDisk.png" width=32 alt="Changes on disk icon" class="no-border" >}} | Changes on disk | Indicates that there were changes on disk.<br/>For example, a file was added or removed. |
48-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/RevChangesVersion.png" width=32 alt="Studio Pro changes icon" class="no-border" >}} | Studio Pro changes | Indicates that there was a change to the Studio Pro version used to work with the app.<br/>For example, when upgrading the app from a previous version to the latest one. |
49-
| {{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/Solution.png" width=32 alt="Solution version changes icon" class="no-border" >}} | Solution version changes | Indicates that a [solution module](/refguide/configure-add-on-and-solution-modules/) used in the app was updated. |
52+
* **Synced** – shown when revision exists locally as well as on the server
53+
* **Local** – shown when the revision is only available locally, because a local commit was made
54+
* **On server** – shown when the revision is only available on the server; this is an indicator there is incoming work that will have to be merged before being able to push new commits to the server
5055

51-
Hover over this column in Studio Pro to get a textual summary of the changes.
52-
53-
### Author{#author}
56+
#### Author{#author}
5457

5558
The person who committed the change.
5659

57-
### Date{#date}
58-
59-
The date the revision was created, it can have one of the following values:
60+
#### Date/Time{#datetime}
6061

61-
* **Today** - shown when revision was created today.
62-
* **Yesterday** - shown when revision was created yesterday.
63-
* the date - shown when the revision was created earlier than yesterday.
62+
The date the revision was created.
6463

65-
### Time{#time}
64+
#### Message{#message}
6665

67-
The time the revision was created.
68-
69-
### Message{#message}
70-
71-
The message saved with the commit. If the message is long, you can read it more easily in the Message tab page, below.
66+
The message saved with the commit. If the message is long, you can read it more easily in the **Message** tab page by selecting the revision.
7267

7368
## Details of Revisions
7469

75-
Below the grid are a number of tabs which give further details about the currently-selected revision.
70+
On the right of the grid are a number of tabs which give further details about the currently-selected revision.
7671

7772
### Message
7873

7974
This tab shows the message saved when these changes were committed.
8075

81-
### Related Stories
82-
83-
This tab shows a list of stories that are related to the changes.
76+
The **Mendix version** that was used to commit the revision to the model is also shown.
8477

85-
### Changes in Model
78+
### Model Changes
8679

8780
This tab shows a list of documents that were changed in the selected revision. From here you can jump to the currently selected changed document by clicking **Go to**, assuming the document still exists in the current version.
8881

89-
The **Mendix version** that was used to commit the revision to the model is also shown.
82+
The search bar within the tab can be used to filter the list of documents.
9083

91-
### Changes on Disk
84+
### Disk Changes
9285

9386
This tab shows a list of the files that were changed on disk. You can see whether files were added, deleted or modified.
9487

88+
The search bar within the tab can be used to filter the list of files.
89+
90+
### Stories
91+
92+
This tab shows a list of stories that are related to the changes.
93+
9594
## Read More
9695

9796
* [Version Control](/refguide/version-control/)
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
7.56 KB
Loading

0 commit comments

Comments
 (0)