Skip to content

Commit c29515e

Browse files
authored
Feature/add version control user guide (#205)
1 parent 9481ee2 commit c29515e

File tree

8 files changed

+66
-8
lines changed

8 files changed

+66
-8
lines changed

content/en/docs/2025.3/Guides/cortex-gateway/settings/version-control.md

-7
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: "Version Control"
3+
linkTitle: "Version Control"
4+
description: "View and manage differences between flows in the current user's repository and the Master Repository."
5+
weight: 90
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Summary
11+
12+
The Version Control page displays the flow hierarchy for the current user, indicating whether the current user’s flows, stored in the user’s repository, are the same as or differ from the Master Versions, stored in the Master Repository.
13+
14+
## Anatomy
15+
16+
{{< figure src="/images/Version Control.png" title="Version Control" >}}
17+
18+
Only flows with Edit permissions for the current user are displayed in the Version Control grid.
19+
20+
## Actions
21+
22+
### Get Master
23+
24+
Any flows that have been committed to the Master Repository by another user are indicated by a downward pointing arrow {{< image src="/images/Version Control - Master Updated.png" >}}. These newer Master Versions may be pulled into the user’s repository by selecting them and clicking the `Get Master` button; if `Get Master` is selected for a flow that also has user uncommitted changes, these changes will be lost and the flow will be overwritten with the Master Version from the Master Repository.
25+
26+
See the [Use Version Control][Use Version Control tutorial] tutorial for a step-by-step guide.
27+
28+
### Commit Changes
29+
30+
Any flows in the user’s repository that have uncommitted changes are indicated by an upward pointing arrow {{< image src="/images/Version Control - Uncommitted Changes.png" >}}. These flows may be committed to the Master Repository by selecting them and clicking the `Commit Changes` button; if any flows selected to be committed have a new Master Version committed by another user a dialog will be displayed prompting conflicts to be resolved by taking either the version to be committed (`Take your version`) or `Take master version` resulting in a `Get Master` being performed.
31+
32+
See the [Use Version Control][Use Version Control tutorial] tutorial for a step-by-step guide.
33+
34+
## Remarks
35+
36+
### Known Limitations
37+
38+
* Parent groups must also have edit permissions, in addition to the flows, otherwise the group and flows contained within it will not be displayed.
39+
40+
## See Also
41+
42+
### Related Concepts
43+
44+
None
45+
46+
### Related Tutorials
47+
48+
* [Use Version Control][Use Version Control tutorial]
49+
50+
[Use Version Control tutorial]: {{< url path="Cortex.Tutorials.Administration.VersionControl.UseVersionControl" >}}

content/en/docs/2025.3/Tutorials/Administration/package-management.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Package Management"
33
linkTitle: "Package Management"
4-
description: "This section includes tutorials about managing packages on the {{% ctx %}} platform."
4+
description: "This section includes tutorials about creating and managing packages."
55
weight: 200
66
---
77

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: "Version Control"
3+
linkTitle: "Version Control"
4+
description: "This section includes tutorials about performing bulk version control operations including Get Master and Commit Changes."
5+
weight: 150
6+
---
7+
8+
# {{% param title %}}
9+
10+
## Use Version Control
11+
12+
{{< scribe title="How_to_use_Version_Control_Management" id="DsyGmkx8QRynHP54ZRP0Ew" >}}
Loading
Loading
Loading

data/urls.toml

+3
Original file line numberDiff line numberDiff line change
@@ -2786,6 +2786,9 @@
27862786
[Cortex.Tutorials.Administration.StudioExport]
27872787
MainDoc = "/docs/tutorials/administration/studio-export"
27882788
ExportIndividualFlows = "/docs/tutorials/administration/studio-export/#export-individual-flows"
2789+
[Cortex.Tutorials.Administration.VersionControl]
2790+
MainDoc = "/docs/tutorials/administration/version-control"
2791+
UseVersionControl = "/docs/tutorials/administration/version-control/#use-version-control"
27892792
[Cortex.Tutorials.Operations]
27902793
MainDoc = "/docs/tutorials/Operations"
27912794
[Cortex.Tutorials.Operations.Overview]

0 commit comments

Comments
 (0)