Skip to content

Commit ee8fb42

Browse files
committed
docs: secret sneaky auto-refresh checkbox
Also reworded a little bit; the Studio pieces were weird.
1 parent 3732250 commit ee8fb42

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,33 @@ Embedded Git support for InterSystems platforms, supporting unified source contr
3434
3535
## Basic Use
3636
37+
The point of Embedded Git is to intercept events made through all editors - both IDEs and the management portal - so that changes are reflected in the filesystem, in a git repo, and able to be shared with others. There are also source-control specific menus to help you do key tasks.
38+
3739
### Source Control
3840
3941
For those with less experience using source control, we recommend this [page](/docs/scintro.md) for a quick introduction to source control / change control basics.
4042
4143
### Health Connect Cloud
42-
git-source control is the recommended source control for Health Connect Cloud. [This page](/docs/hcc.md) covers HCC specific usage of git-source-control, including the recommended development workflow, initial setup, and CICD pipelining.
44+
45+
git-source control is the recommended source control for Health Connect Cloud. [This page](/docs/hcc.md) covers HCC specific usage of git-source-control, including the recommended development workflow, initial setup, and CI/CD pipelining.
4346
4447
### VSCode
45-
The same right click menus as in Studio live under "Server Source Control..." when right-clicking in a file (in the editor) or on a file when exploring an isfs folder. The top level "source control" menu is accessible through the command palette or the source control icon in the top right of the editor.
4648
47-
### Studio
49+
Source control menus will appear under "Server Source Control..." when right-clicking in a file (in the editor) or on a file when exploring an isfs folder. The top level "source control" menu is accessible through the command palette or the source control icon in the top right of the editor.
4850
49-
Note: Studio has been deprecated. VSCode is the IDE recommended by InterSystems.
51+
For full details on all of the menu items, see [this reference page](/docs/menu-items.md).
52+
53+
### Management Portal Editors
5054
51-
Add an existing file for tracking by right-clicking on it in the workspace/project view and choosing Git > Add.
52-
This same menu also has options to remove (stop tracking the file), discard changes (revert to the index), or commit changes.
55+
In relevant editors in the management portal, there are two icons that allow access to the same source control functionality as in IDEs. Click the source control icon to see the menu, and the clipboard to see output from previously run commands in your browser session.
56+
57+
*Important*: if using source control for interoperability, check the "Permit Enabling Automatic Refresh of Management Portal Pages" box in the management portal, at the page: Interoperability > Manage > Configuration > Interoperability Settings. This mitigates a potential for lost work.
58+
59+
### Studio
60+
61+
Note: Studio has been deprecated. VSCode is the IDE recommended by InterSystems.
5362
54-
You can browse file history and commit changes through a user interface launched from the top level Git > "Launch Git UI" menu item. There is also a page for configuring settings.
63+
That said, the same menu items and editor behavior will also work in Studio. There is a top-level "Git" menu with access to various operations and pages dependent on the current editor context.
5564
5665
## Notes
5766

0 commit comments

Comments
 (0)