Skip to content

Commit 7346166

Browse files
committed
docs: more TODOs
1 parent cc1df3f commit 7346166

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/hcc.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,18 @@ The recommended workflow for Health Connect Cloud is to: create an interface bra
2424
A Health Connect Cloud Dev deployment will have at least one Protected Namespace and should also have a dedicated User Namespace for each user. These namespaces can be configured via the Cloud Portal for the selected Health Connect Cloud deployment. It is important for changes to originate in User Namespaces. Protected Namespaces in the Dev deployment must always be kept up to date with the development branch of the associated GitLab repo, either through a CI/CD pipeline or by use of the Git Pull page from Embedded Git.
2525
# TODO: picture of GitLab/deployment/branch relationship
2626

27-
# InterSystems Responsibilities
27+
# Prerequisites: InterSystems Responsibilities
2828
- Create GitLab Repository for the Organization
2929
- Grant appropriate access and privileges to the GitLab Repository
3030
- Onboard Customers on Source Control Tools for Health Connect Cloud
3131
- Update Change Control Documentation and Videos
3232
- [Official Change Control Documentation](https://docs.intersystems.com)
3333
- [Learning Videos](https://learning.intersystems.com/course/view.php?name=HCCSourceControlUI)
3434

35-
# Customer Responsibilities
35+
# InterSystems-Recommended Workflow - Embedded Git and GitLab
36+
37+
## Notes on Customer Responsibilities
38+
TODO: flesh this out: configuration, communication, policy/process constraints around approvals, onboarding of users/namespaces
3639

3740
## Example Use Case 1: Inbound HL7 Service
3841
> As a Health Connect Cloud user, I want to add a new inbound HL7 service to receive HL7 messages from a lab.
@@ -98,7 +101,7 @@ Use the link in the output of the sync in order to create a merge request in the
98101

99102
Suppose you begin working on a larger project in one branch, and then need to shift to something else. The proper approach to this in Embedded Git is to commit your in-progress work on the first interface, and then to switch to a new branch. This branch will be based on the development branch and may be missing components from the first project, but that's OK. You can always switch back to the first interface branch to continue work there.
100103

101-
## Example Use Case 3: Onboarding a New User
104+
## Example Use Case 3: Onboarding a New User Namespace
102105

103106
### Configuring Git on a New Namespace
104107

0 commit comments

Comments
 (0)