Dojo: Day 1 - Running Egeria

[planetf1]

Our Dojo series is being updated for early 2022.

This issue will track changes for Day 1

[planetf1]

Work outline (for Day 1 only)

• Navigation outline (1st pass)
• empty pages
• CODEOWNERS
• Clarify prereqs
• Define clear objective

Notable differences from prior version of dojo

• We will no longer guide user either through git clone (for contributors) or running docker
• we will use helm chart instead. See - [ ] Base chart with single egeria, no configuration - New base chart to support dojo or modify existing base chart egeria-charts#75 alongside microk8s
• chart usage instructions must be resiliant - how to clean up/start again, stop etc
• prereq need to be clear inc. license. Also OS (win=wsl2)
• clarify REST API is not supported (see Day 2 for developer APIs)
• Since REST APIs are being used in examples, need to look at formatting. See Swagger OpenAPI doc formatting - multiple single/2char columns make for poor presentation egeria#5089 (current docs unreadable)
• review postman collection(s) & ensure simple (by day, a subset? labelling)
• consider whether to also provide curl examples
• add info on configuring/using an existing connector (postgres? XTDB?)
• existing videos need updating
• community info needs clarifying at beginning - where to get help, links, issues
• jupyter labs - demonstrating API calls, caveating with support sttaement on REST
• add info on launching egeria locally (simple use only - complex topics are on day 5 inc non-std security)

[planetf1]

Work still to do as of 12 Jan:

• Request feedback from egeria team
• Solicit m1 feedback
• Update introductory presentation/video with new content from @mandy-chessell if available
• add docs on pulling k8s logs to diagnostics guide
• Correct links/cleanup main k8s docs chart info (they still refer to old insructions - though not directly referenced in dojo)
• Add more 'Test yourself' content to each section
• Add typical timings/schedule (dojo outline)
• Add typical timings/schedule (in day 1 material)
• Write summary
• Document which coco pharma notebooks should be run
• Move the egeria-charts to release, remove use of '--devel' in docs, and add as callout-note
• Update https://odpi.github.io/egeria-docs/guides/operations/kubernetes/k8s/#ingress to refer to rancher not microk8s . Also move this section to the earlier concepts section to avoid confusion
• recommend installer rancher-desktop via .dmg on macos, not homebrew. clarify what command aliases should be set up
• can we make it easier to work through the k8s into/install/helm without the user then continuing on with the chart install? Could snippets help?
• Suggestion - Move the 2022 Dojo to top and push the 2021 Dojo down to the bottom #221
• Typo? Ingres rather than Ingress in heading? #222
• refer to new Dojo in https://odpi.github.io/egeria-docs/education/#the-egeria-dojos
• add link to k8s setup in https://odpi.github.io/egeria-docs/education/#the-egeria-dojos
• clarify setup of coco pharma lab. confusion between tutorial/dojo/reference. needs to specify required port forwarding
• installing Rancher - select 'containerd' if prompted
• review helm command invocations in chart-specific docs. Appears to have inverted parameters in at least one place
• Address all remaining issues & respond to Install Notes on my M1 #223
• ensure all quoted section using shell have the correct annotation
• Move information on accessing applications to concepts section in k8s doc
• Clarify objective of day 1
• Include section on egeria-docs
• Final basic formatting check-through prior to running the lab
• add intro/summary to each section of the day ?
• @davidradl incorporate UI tutorial content

[planetf1]

Most of the required changes are now made

Ideally we'd have more test-yourself section, an updated presentation, & more cleanup of related content, but
this is now in a reasonable state to run the Dojo with.

Will close this issue now and will handle further changes as individual issues.