...
- Decide on how participants prepare for workshop and how they will build and test their code
- Plan/create on the education we should give at the start of the session, such as ...
- How to use github
- How to set up dev environment
- Knowledge of what a sustainability initiative entails
- Understanding of Coco Pharmaceuticals and the different personas they will be working for/with
- Create 30+ issues in https://github.com/odpi/egeria-samples-api/issues that define the work that the participants will do. These need to take into account different levels of skill. They will be aligned to the different persona in Coco Pharmaceuticals
- Build the open metadata archives that seed the metadata repositories used by the participants - see https://github.com/odpi/egeria-samples/tree/master/sample-metadata-archives/coco-metadata-archives
- Ensure all APIs that participants expected to use have FVTs defined so they do not encounter any problems with the base Egeria code
- Plan a walkthrough of the demo for the end of the session that highlights the achievements of the participants (and fills in the gaps that occur due to gaps in the contributions).
Participant work items
The participants will be building sample programs that use the Egeria clients to retrieve and maintain open metadata. Some samples show the use of metadata in conjuction with processing data from the business systems and reference data from the standards and regulations. Each sample is independent of the others, although as more samples are contributed, the samples that query will see more open metadata returned.
The samples are divided into the following groups:
- Extending the governance program to include a sustainability focus.
- Creating an inventory of Coco Pharmaceuticals operations.
- Finding and cataloguing the data that describes the impact of their operations.
- Building the sustainability dashboard to continuously monitor the sustainability status of Coco Pharmaceuticals.
- Assessing and improving IT operations.
The issues for participants are located in https://github.com/odpi/egeria-samples-api/issues. They are tagged with labels indicating which group of samples they contribute to, the implementaton language (python or java) and how difficult they are. There are 4 level of difficulty:
- Good first issue - only one Egeria call to make since more time will be spent mastering the whole contribution process. There will be detailed instructions on what to code and where to put it.
- New to open source - typically linking a few Egeria calls with some logic to process the results - the coding wil lbe relatively easy to give them time to master the Git/PR processes. There wil lbe guidance on which Egeria calls to use.
- Experienced in open source - more complex coding around the Egeria APIs - their challenge will be to learn about Egeria and so they will be guided to the right documentation - but they need to follow it to determi the right API calls.
- Expert - these are likely to be regular contributors to Egeria and are expected to be familiar with the basic types and the documentation. They will probably be using APIs thata are new to them.
The descriptions in each issue will eventually contain the following information:
- Summary of task and its purpose
- Background reading and similar examples
- What has been provided - understanding the starting point - where to put your code
- Suggested list of tasks
- Before you start
- Basic function
- Suggested extensions
- Building test cases
- What to document and where.
- Javadoc
- README.md
- package-info.java
The git repository will contain the directory structures, source files, and much of the build system so that we can build all samples as they are contributed.