Skip to content

Commit 7ebb65c

Browse files
MariaShaposhnikovaMariaShaposhnikova
authored
Merge pull request #10883 from mendix/Maria-VC-review
Suggest changes for Version Control Docs
2 parents 0073085 + a3a68ad commit 7ebb65c

6 files changed

Lines changed: 9 additions & 7 deletions

File tree

‎content/en/docs/refguide/version-control/_index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ Version Control allows you to manage your app development in two ways:
1616
* Firstly, it allows you to store ([commit](/refguide/version-control/glossary/#commit)) the current revision of your model and all its resources. You give it an identifier so that you can get that revision again and share it with other team members.
1717
* Secondly, it allows work to take place on multiple [development lines](/refguide/version-control/glossary/#development-line) so that several different features can be worked on at once. These development lines can then be [merged](/refguide/version-control/glossary/#merge) back together so that your [main line](/refguide/version-control/glossary/#main-line) contains all the completed features that have been worked on separately.
1818

19+
For more information on what version control is and version control-related definitions, see [Version Control Glossary](/refguide/version-control/glossary/).
20+
1921
Version control in Mendix is built on top [Git](https://git-scm.com). The concepts will be familiar to seasoned users of these version control systems (VCS). Mendix simplifies the VCS commands by building them into Studio Pro and the Mendix Portal.
2022

2123
## Mendix Team Server

‎content/en/docs/refguide/version-control/using-version-control-in-studio-pro/managing-branches.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: "Describes how to work with branches."
1010

1111
A repository (remote or local) can contain a number of development lines. Each development line offers independent development from the other development lines. In the simple case there is just one development line called the main line. All development then happens inside that one line.
1212

13-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/main-branch-line.png" class="no-border" >}}
13+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/main-branch-line.png" >}}
1414

1515
It is often convenient to have more than one development line. For example, one development line is for fixing bugs in the currently deployed version of your app and another line is where you develop new functionality. If you then find a bug in the deployed version, you can fix it in the corresponding development line irrespective of the state of the development line where new functionality is developed. For more information about branches, see [Version Control Glossary: Branches](/refguide/version-control/glossary/#branches).
1616

‎content/en/docs/refguide/version-control/using-version-control-in-studio-pro/push-pull.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Git only creates a local commit. To submit your local commit (or commits) to the
7272

7373
For example, you are developing a feature together with another developer on the same branch. You both have the same starting point (3). When your colleague commits a change, you can choose to retrieve these changes and integrate them. To enable this, developers first need to commit existing changes locally (6), so that the changes can be automatically merged when they are retrieved by other developers. After this, you commit the merged result, and optionally push the merged result (7) to be used by your colleague. Because changes are already explicitly committed, you can always see what you changed and you cannot accidentally override your local changes when you are resolving conflicts.
7474

75-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/incoming-changes.png" alt="Incoming changes in Git" class="no-border" >}}
75+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/incoming-changes.png" alt="Incoming changes in Git" >}}
7676

7777
In general, it is a good idea to commit after implementing one feature or fixing one bug. By committing often, your work is integrated with the work of others regularly. The benefits of committing include the following:
7878

@@ -132,7 +132,7 @@ If the changes are discovered during the push, an information dialog with instru
132132

133133
Git prevents you from pushing your changes if it sees your changes and the remote changes as potentially conflicting. In this diagram, you see that Git does not know how to combine commits #3 and #4.
134134

135-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/server-your-work.png" alt="The local changes consist of commits 1, 3, while the remote server has commits 1, 2, and 4 on the same branch." class="no-border" >}}
135+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/server-your-work.png" alt="The local changes consist of commits 1, 3, while the remote server has commits 1, 2, and 4 on the same branch." >}}
136136

137137
There are two ways for Studio Pro to combine the commits: **Rebase** (default) and **Merge**. For more information, see [Combining Changes and Conflict Resolution](/refguide/resolving-conflicts/#combine-changes).
138138

‎content/en/docs/refguide/version-control/using-version-control-in-studio-pro/reverting-changes.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Deletes of documents, folders, and modules can also be reverted. This brings the
1818

1919
You can revert changes in the **Changes** pane, from **Version Control** > **Revert All Changes**, or from the right-click menu on the document you want to revert.
2020

21-
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/revertx2.png" alt="Two ways of reverting" class="no-border" >}}
21+
{{< figure src="/attachments/refguide/version-control/using-version-control-in-studio-pro/revertx2.png" alt="Two ways of reverting" >}}
2222

2323
{{% alert color="info" %}}
2424
You can also **Revert All Changes** while [merging](/refguide/resolving-conflicts/#merge). This will restore your app to the most recent commit, discarding changes creating by the merging process.

content/en/docs/refguide/version-control/using-version-control-in-studio-pro/peer-review.md renamed to content/en/docs/refguide/version-control/using-version-control-in-studio-pro/using-history.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ The [Name and Email settings](/refguide/preferences-dialog/#name) can be adjuste
2525

2626
Select a revision to see additional details, such as related stories, changed documents, Studio Pro version, and changes on disk. Icons summarize the kinds of changes that happened in the app.
2727

28-
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" class="no-border" >}}
28+
{{< figure src="/attachments/refguide/modeling/menus/version-control-menu/history-dialog/revisions.png" >}}

‎content/en/docs/refguide/version-control/version-control-troubleshooting/repository-size.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This tool is executed on a Mendix Git repository. If your Mendix app is still on
7979

8080
The cleanup tool will reduce the size of the repository to a minimum, by only retaining the latest commit of the main branch. This means that all work on branches that have been merged to main branch are kept, but the commits themselves (author, changes per commit, ...) are not.
8181

82-
{{< figure src="/attachments/refguide/version-control/troubleshoot-version-control-issues/git_fixer_mode.png" class="no-border" >}}
82+
{{< figure src="/attachments/refguide/version-control/troubleshoot-version-control-issues/git_fixer_mode.png" >}}
8383

8484
{{% alert color="info" %}}
8585
Uncommitted work, or work committed to branches that have not been merged to the main branch, will be permanently removed from the repository.
@@ -207,7 +207,7 @@ If you are still on SVN in Studio Pro 9, see the [Recommendation on Avoiding Git
207207

208208
Follow the decision tree in the image below to troubleshoot Git-related performance issues:
209209

210-
{{< figure src="/attachments/refguide/version-control/troubleshoot-version-control-issues/migration-advice-mx11.png" class="no-border" >}}
210+
{{< figure src="/attachments/refguide/version-control/troubleshoot-version-control-issues/migration-advice-mx11.png" >}}
211211

212212
\* In case your *.git* folder is less than 2GB but you are having performance issues when cloning, please see the [Verify Full Clone Through Git CLI](/refguide/troubleshoot-team-server-issues/#verify-full-clone-through-git-cli) section in *Troubleshooting Team Server Issues* and contact Support with the relevant information.
213213

0 commit comments

Comments
 (0)