Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 1.97 KB

README.md

File metadata and controls

56 lines (39 loc) · 1.97 KB

learn-cortex

Repository for setting up test entities and learning how to use Cortex.

We're just kicking the tires on this and have limited content, but if you want to give it try please follow the directions listed below.

Pre-requistites

  • A Cortex instance.

  • The Command prompt (on a Mac: Finder -> Applications -> Utilities -> Terminal)

  • Homebrew installed

    TL;DR

    This command will install homebrew if you don't already have it installed.

    which brew > /dev/null || /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    

Installation

This repository uses just to run the set up tasks.

brew install just
just setup

The Learn Cortex entity

You will now have an entity named Learn Cortex in your catalog.

image

Click on the 'Learn Okta' scorecard and expand the failing Scorecard rule to see instructions on how to set up a dev instance of Okta.

image

Contributing

It is hoped that this will be a group-sourced project. Please fix any errors and add new content using the available workflows in your sandbox.

Workflows

There are several workflows that will be available from the Learn Cortex entity:

  • Learn Cortex - create Scorecard

    This will create a Learn Cortex scorecard from a template in your sandbox. The intent is that you would add markdown to the CQL rule in the Learned level to help educate users on a topic.

  • Learn Cortex - publish Scorecard

    This will publish a Learn Cortex scorecard from your sandbox to git. A Slack message will be posted to #learn-cortex alerting users to new content in the repository.

  • Learn Cortex - install Scorecard

    Install a Learn Cortex scorecard from the learn-cortex repository. This allows you to add new content using a workflow. Alternatively, you can run update your git checkout and run 'just'.