First full lesson

episodes/01-orientation.md → _episodes/01-orientation.md

@@ -1,6 +1,24 @@
-
-
-# WELCOME!!
+---
+title: "Workshop Welcome"
+teaching: 0
+exercises: 15
+questions:
+- "Question here"
+objectives:
+- "List the objectives"
+keypoints:
+- "List the key takeaways for the episode"
+workshopOverviewName: "COmanage Workshop: Managing Identities & Collaborations"
+workshopOverviewURL: "https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md"
+lessonOverviewName: "CO101 - Workshop Intro & Getting to Know COmanage"
+lessonOverviewURL: "../index.md"
+previousEpisodeName:
+previousEpisodeURL:
+nextEpisodeName: "2. About Identity Registries" 
+nextEpisodeURL: "/_episodes/02-identityRegistries.md"
+---
+
+# 1. WELCOME!!
 
 ## Who is here? 
 
@@ -21,33 +39,35 @@ Etherpad: https://beta.etherpad.org/p/LAWk3BnFJooMVMCHq56L
 * Safety (emergency exits)
 * Norms (get up when you need to)
 
+# Workshop objectives
+
+We have selected a set of lessons with some specific goals:
+
+* Provide you with a strong understanding of what COmanage is designed to do and how it may fit your needs
+* Ensure that you are oriented to COmanage's structure and terminlogy so that you be well positioned to extend your knowledge via COmanage's online documentation
+* Provide a hands-on experience in working wtih COmanage in an enviornment where there are plenty of resources to support your learning.
+
 # About the Workshop
 
 * Who are your instructors? 
 * What is Spherical Cow Group, and what is the relationship to COmanage
 * New Course! - feedback is helpful
 
-## Course Documentation
+# Course Documentation
 
 https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md
 
-### Documentation structure
+## Documentation structure
 
 The lessons that we will be going over during this Workshop cover a subset of topics about COmanage. The 100-level lessons (like this one!) are designed to provide an orientation to COmanage. 200-level lessons discuss installation and configuration. 300-level lessons provide insight into specific features of COmanage. And, 400-level lessons (which are not included in this Workshop) provide insights and training to those who may be writing code to extend or customize what COmanage can do.
 
-We have selected a set of lessons with some specific goals:
-
-* Provide you with a strong understanding of what COmanage is designed to do and how it may fit your needs
-* Ensure that you are oriented to COmanage's structure and terminlogy so that you be well positioned to extend your knowledge via COmanage's online documentation
-* Provide a hands-on experience in working wtih COmanage in an enviornment where there are plenty of resources to support your learning.
-
-### Paper? In a tech workshop?
+## Paper? In a tech workshop?
 
 Recognizing that different people "lock in" new knowledge in different ways, we wanted to provide you will context-specific resources that can help trigger the recall of key concepts when you head back to your home institutions. The work we will be doing will be hands on, though these environments will be on Virtual Machines that will be refreshed in two weeks. 
 
 The packets provide planning worksheets for you to jot down how you may apply these concepts to your own enviornment. These insights will help provide a great starting point when you are starting to implement some of these ideas on your own.
 
-### Documentation conventions
+## Documentation conventions
 
 If you see the hands on image (like above!), it will be time for you to put fingers to keyboard and try things out. In many cases we will ask you to set up specific things, and sometimes you'll have flexibility in what you create. Regardless, it is important for your understanding that you do all of the hands on activities. Later lesson activities will build on earlier ones.
 
@@ -56,6 +76,16 @@ If you see the hands on image (like above!), it will be time for you to put fing
 * :memo: icon - These are links to the worksheets and resources that we will be referencing during the workshop. 
 * :rocket: icon - COmanage makes several processes easier by automating work.
 
-### Contributing to training materials
+## Contributing to training materials
 
 Do you see a typo that is annoying you? You've thought about a better way of explaining a concept? We encourage you to contribute those ideas! The training documentation is stored on Github. You can either create an issue, or you are welcome to submit a pull request with your ideas.
+
+---
+
+NEXT SECTION: [2. About Identity Registries](/_episodes/02-identityRegistries.md)
+
+---
+
+LESSON OVERVIEW: [CO101 - Workshop Intro & Getting to Know COmanage](../index.md)
+
+WORKSHOP OVERVIEW: [COmanage Workshop: Managing Identities & Collaborations](https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md)

episodes/01-identityRegistries.md → _episodes/02-identityRegistries.md

@@ -8,8 +8,18 @@ objectives:
 - "List the objectives"
 keypoints:
 - "List the key takeaways for the episode"
+workshopOverviewName: "COmanage Workshop: Managing Identities & Collaborations"
+workshopOverviewURL: "https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md"
+lessonOverviewName: "CO101 - Workshop Intro & Getting to Know COmanage"
+lessonOverviewURL: "../index.md"
+previousEpisodeName: "1. Workshop Welcome"
+previousEpisodeURL: "/_episodes/01-orientation.md"
+nextEpisodeName: "3. Why COmanage"
+nextEpisodeURL: "/_episodes/02-whyCOmanage.md"
 ---
 
+# 2. About Identity Registries
+
 COmanage is an Identity Registry. What is a registry?
 
 ## What is an identity registry?
@@ -48,11 +58,7 @@ COmanage is a Membership Management Service. These tools provide many things:
 * The ability to assign rights and permissions to people through roles, groups, etc
 * The ability to distribute the management of rights and permissions to multiple people. _For example, a project's Principal Investigator can manage the rights and permissions for his/her project group_
 
-COmanage is not the only Membership Management Service. Examples of other services include
-
-* HEXXA
-* PERUN
-* <others... should have a more complete list>
+COmanage is not the only Membership Management Service. Examples of other services including HEXXA and PERUN.
 
 Some will have strong preferences of one tool over another, though at their core, each of these tools serve the same basic functions. Their differences are primarily in the emphasis each tool makes on various features, how the development of the tool is managed, and how the tool is packaged with other tools.
 
@@ -61,3 +67,15 @@ Since you are here, we are assuming that you have already made the choice to use
 --
 
 COmanage is a collaboration management platform designed for virtual organizations. With customizable enrollment flows, clear audit trails, and clear APIs that allow for integration with a variety of collaborative applications such as wikis, mailing lists, and more, COmanage provides VOs with an organized yet simple interface for identity and access management.
+
+---
+
+NEXT SECTION: [3. Why COmanage](/_episodes/03-whyCOmanage.md)
+
+PREVIOUS SECTION: [1. Workshop Welcome](/_episodes/01-orientation.md)
+
+---
+
+LESSON OVERVIEW: [CO101 - Workshop Intro & Getting to Know COmanage](../index.md)
+
+WORKSHOP OVERVIEW: [COmanage Workshop: Managing Identities & Collaborations](https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md)

episodes/02-whyCOmanage.md → _episodes/03-whyCOmanage.md

@@ -8,8 +8,17 @@ objectives:
 - "List the objectives"
 keypoints:
 - "List the key takeaways for the episode"
+workshopOverviewName: "COmanage Workshop: Managing Identities & Collaborations"
+workshopOverviewURL: "https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md"
+lessonOverviewName: "CO101 - Workshop Intro & Getting to Know COmanage"
+lessonOverviewURL: "../index.md"
+previousEpisodeName: "2. About Identity Registries" previousEpisodeURL: "/_episodes/02-identityRegistries.md"
+nextEpisodeName: "4. COmanage Capabilities"
+nextEpisodeURL: "/_episodes/04-capabilities.md"
 ---
 
+# 3. What is COmanage?
+
 Where does COmanage sit in an Identity and Access Management (IAM) architecture?
 
 ## What COmanage does
@@ -57,4 +66,16 @@ Your organization may be modeled by departments and centers, but it may also hav
 
 ### Provisioning
 
-Sometimes having individuals in groups is all you need to provide the correct access to your systems, services and resources. Other times you will have more complicated or sophisticated needs, so a dedicated tool for group management and provisioning will be helpful. Either way COmanage's single view of an individual is an asset to any system using the information.
+Sometimes having individuals in groups is all you need to provide the correct access to your systems, services and resources. Other times you will have more complicated or sophisticated needs, so a dedicated tool for group management and provisioning will be helpful. Either way COmanage's single view of an individual is an asset to any system using the information.
+
+---
+
+NEXT SECTION: [4. COmanage Capabilities](/_episodes/04-capabilities.md)
+
+PREVIOUS SECTION: [2. About Identity Registries](/_episodes/02-identityRegistries.md)
+
+---
+
+LESSON OVERVIEW: [CO101 - Workshop Intro & Getting to Know COmanage](../index.md)
+
+WORKSHOP OVERVIEW: [COmanage Workshop: Managing Identities & Collaborations](https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md)

episodes/03-capabilities.md → _episodes/04-capabilities.md

@@ -1,5 +1,5 @@
 ---
-title: "Focus on Capabilities"
+title: "COmanage Capabilities"
 teaching: 15
 exercises: 0
 questions:
@@ -8,8 +8,18 @@ objectives:
 - "List the objectives"
 keypoints:
 - "List the key takeaways for the episode"
+workshopOverviewName: "COmanage Workshop: Managing Identities & Collaborations"
+workshopOverviewURL: "https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md"
+lessonOverviewName: "CO101 - Workshop Intro & Getting to Know COmanage"
+lessonOverviewURL: "../index.md"
+previousEpisodeName: "5. COmanage Structure" 
+previousEpisodeURL: "/_episodes/05-structure.md"
+nextEpisodeName: "3. What is COmanage"
+nextEpisodeURL: "/_episodes/03-whyCOmanage.md"
 ---
 
+# 4. COmanage Capabilities
+
 What capabilities should you consider as you select (or build) a registry for your higher education or research organization?
 
 ## Onboarding Capabilities
@@ -45,3 +55,14 @@ Once you have a single record for each of your users, you can use this informati
 
 ... API, Bulk operations, Search
 
+---
+
+NEXT SECTION: [5. COmanage Structure](/_episodes/05-structure.md)
+
+PREVIOUS SECTION: [3. What is COmanage](/_episodes/03-whyCOmanage.md)
+
+---
+
+LESSON OVERVIEW: [CO101 - Workshop Intro & Getting to Know COmanage](../index.md)
+
+WORKSHOP OVERVIEW: [COmanage Workshop: Managing Identities & Collaborations](https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md)

_episodes/05-structure.md

@@ -0,0 +1,62 @@
+---
+title: "The structure of COmanage"
+teaching: 15
+exercises: 0
+questions:
+- "Question here"
+objectives:
+- "List the objectives"
+keypoints:
+- "List the key takeaways for the episode"
+workshopOverviewName: "COmanage Workshop: Managing Identities & Collaborations"
+workshopOverviewURL: "https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md"
+lessonOverviewName: "CO101 - Workshop Intro & Getting to Know COmanage"
+lessonOverviewURL: "../index.md"
+previousEpisodeName: "4. COmanage Capabilities"
+previousEpisodeURL: "/_episodes/04-capabilities.md"
+nextEpisodeName: 
+nextEpisodeURL: 
+---
+
+# 5. How is COmanaged structured?
+
+# People
+
+OBJECT | DESCRIPTION | Introduced in
+------ | ----------- | -------------
+`CO Person`:gear: | The representation of a person in COmanage | [CO310-01](https://github.internet2.edu/lpaglione/COmg-CO310-modelPeople/blob/master/_episodes/01-COperson.md)
+`CO Group`:gear: | A specific COmanage organizational structure for representing certain collections of `CO Persons`:gear: | [CO320-03](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/03-groups.md)
+`Identity Source`:gear: | Information about a person as obtained from an external source such as LDAP, netFORUM or ORCID | [CO310-02](https://github.internet2.edu/lpaglione/COmg-CO310-modelPeople/blob/master/_episodes/02-orgIdentity.md)
+`Identity Source Records`:gear: | COmanage's cached value of the values at the source  | [CO310-02](https://github.internet2.edu/lpaglione/COmg-CO310-modelPeople/blob/master/_episodes/02-orgIdentity.md)
+`CO Person Role`:gear: | The representation of a person's role in COmanage. This object describe the person's role with certain collections of people within your organization or collaboration. These objects are attached to :gear: `CO Person` objects; there may be any number of Roles. | [C0310-04](https://github.internet2.edu/lpaglione/COmg-CO310-modelPeople/blob/master/_episodes/04-permissions.md)
+
+# Organizations/ Collaborations - sub-units
+
+OBJECT | DESCRIPTION | Introduced in
+------ | ----------- | -------------
+`CO`:gear: | any formal or informal group of individuals that work collaboratively in a digital setting. They have a goal of a shared infrastructure that supports their collaborations so that the traditional limitations of localized applications may be overcome. | [CO320-01](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/01-co.md)
+`COU`:gear: | an organizational structure within a CO that differs in how individuals join and/or leave the group, how applications get provisioned or deprovisioned, who manages person membership and privileges in the group, or in the information stored or used about members of the group. | [CO320-02](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/02-cous.md)
+`CO Group`:gear: | A specific COmanage organizational structure for representing certain collections of `CO Persons`:gear: | [CO320-03](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/03-groups.md)
+`CO Department`:gear: | A COmanage object that is used to model organizational departments. They can be used to store a number of attributes about the department, including telephone numbers, email addresses, URLs, identifiers, and the sets of people associated with specific responsibilities within the department. | [CO320-04](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/04-departments.md)
+
+# Linking to Systems Outside of COmanage
+
+OBJECT | DESCRIPTION | Introduced in
+------ | ----------- | -------------
+`Identifier`:gear: | Objects that enable one to connect the information stored about people within the COmanage platform to representations of the same people in systems outside of COmanage | [CO330-01](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/01-identifiers)
+`CO Service`:gear: | Services or applications that can be configured for `CO Persons`:gear: to have access to by participating in the organization or collaboration. | [CO330-02](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/02-coServices.md)
+`Plugin`:gear: | Components that are used to easily customize and extend COmanage Registry functionality. | [CO330-03](https://github.internet2.edu/lpaglione/COmg-CO320-modelOrg/blob/master/_episodes/03-plugins.md) 
+`Provisioners`:gear: | Special Plugins that enable you to Provision to external systems using information stored within COmanage | [CO350](https://github.internet2.edu/lpaglione/COmg-CO350-workflowProvisioning/blob/master/index.md)
+
+---
+
+PREVIOUS SECTION: [4. COmanage Capabilities](/_episodes/04-capabilities.md)
+
+---
+
+NEXT LESSON: [CO201 - Installing COmanage Using Docker Images](https://github.internet2.edu/lpaglione/COmg-CO201-dockerInstallation/blob/master/index.md) 
+
+LESSON OVERVIEW: [CO101 - Workshop Intro & Getting to Know COmanage](../index.md)
+
+WORKSHOP OVERVIEW: [COmanage Workshop: Managing Identities & Collaborations](https://github.internet2.edu/lpaglione/COmg-trainingOverview/blob/master/README.md)
+