[EPIC] Make examples for everything in our documentation.

[bryanpaget]

Throughout all our documentation, whenever we make reference to a feature, we should have an inline example code snippet or a link to a Github repo with an example script or notebook. This EPIC can track tickets scoped to a single example somewhere in the documentation. Add a ticket for each example and cite the exact location in documentation.

[wg102]

First step is going through our documentation to find any places where there should be examples. May also want to consider the documentation/readme is the containers repo, but I think those are already populated by examples.

[wg102]

The page template:

• Overview: N/A
• Analysis:
  • Overview : N/A
  • Kubeflow: [ticket*]
    • The video is private, it needs to be sanctionned correctly, removing the video for now.
  • Jupyter [ticket*]
    • Broken links to "Explore your data"
    • Verify the examples mentionned actually exist
  • Reference to MinIO
  • Link to storage option is broken
  • Rstudio : [ticket*] Good enough just out of date images
    • Working video example.
    • out of date images (2)
    • "You can install R or python packages with conda or install.packages()." -> how to?
    • RShiny: how to example?
  • Remote Desktop
    • Out of date images
  • Unlisted page https://statcan.github.io/aaw/en/1-Experiments/Selecting-an-Image/
• Publishing:
  • Overview : N/A
  • R Shiny: [ticket*] (good example exist)
    • Broken link to Publishing R Shiny (but we also say we don't host them)
    • Broken link + Github Rshiny repo is archived
    • Should we keep the "Publishing on AAW" section?
    • Embedding dashboards into your websites section is "we haven't done it yet, if you have feel free to reach out to us"
  • Dash [ticket*]
    • Broken links...
    • Good example already exist
  • Datasette [tixket*]
    • private video (broken link)
    • Looks like example exist
  • Power BI [ticket*]
    • Example uses minio
    • Broken link
  • Custom [ticket*]
    • broken link for source
    • Possibly add an example?
  • MLOPS:
  • Overview: N/A
  • Machine Learning Models : N/A good examples
  • Training ML Models [ticket]
    • Step 5 evaluate the model and step 6 deploy the model have boxes for code, but no code is provided, nor explanation how to do it.
    • Examples using Argo Workflows-based SDKs have a code section for YAML and Seldon? (yes with a question mark) but no code
  • Storing ML Models [ticket*]
    • Broken link Disks
    • mention of Minio buckets
  • Serving ML Models: N/A Has a good example
  • Integrate with External PaaS : N/A Example are liste in the MLOps Github repo linked
  • Collaboration:
  • Overview
    • Mentions of Minio
    • Sharing with statcan uses minio as example
    • Sharing with the world "ask on slack but it's possible"
    • Out of date images
  • Request a Namespace
  • GEA : N/A Seems to have a decent example
  • Storage:
  • Overview N/A
  • Disks: [ticket*]
    • Very out of date images
    • Might need to tweak the text once images are up to date
  • Azure Blob Storage : N/A, decent example how to migrate data
  • Gitlab : N/A
  • Help/Contact [ticket*]
  • Broken links to video, or the videos were moved/deleted.

[wg102]

Analysis/Kubeflow: Private video, we might want to make it public We can remove the video while it is still being assessed.

Note: For the list above, the [Ticket] means a ticket should be created for the specific issue while [ticket*] means it's general troubles like out of date images, and broken links, many could be included in one issue.

[wg102]

While going through the entirety of our documentation, I noted many broken links and images out of date, but code examples seem to already have been added. Closing this ticket in favor of a smaller ticket addressing the links and images.