EPIC Goal

We should mention how to use the events based system for ingesting entities in RHDH, in what cases might it be beneficial over periodic polling and also highlight limitations.

Background/Feature Origin

We will be including event modules to enable the events system for GitHub Discovery,  Github Org Data,  Bitbucket Cloud Discovery, Bitbucket Server Discovery, Gitlab Discovery, Gitlab Org Data in RHDH 1.8. Thus we should also document how to use/enable them.

User Scenarios

We should include the following in our docs:

• The event modules available in RHDH and how to use/enable them.
• Document when to use the events module but highlight the limitations i.e. for added resilience, continue to use the schedule every 24 hrs.
• For Github, We should continue to advise customers to use wildcards responsibly.

Acceptance Criteria

Release Enablement/Demo - Provide necessary release enablement details
and documents

DEV - Upstream code and tests merged: <link to meaningful PR or GitHub
Issue>

DEV - Upstream documentation merged: <link to meaningful PR or GitHub
Issue>

DEV - Downstream build attached to advisory: <link to errata>

QE - Test plans in Playwright: <link or reference to playwright>

QE - Automated tests merged: <link or reference to automated tests>

DOC - Downstream documentation merged: <link to meaningful PR>

Who is your target persona?

<Role>

What stage of the user journey are you targeting?

<User journey>

Why is this content important?

<Justification>

What is the main user goal aka job to be done?

As a <role>, I want to <goal>

What high level steps does the user need to take to accomplish the goal?

1. <User steps to accomplish goal>
   

What pain points are the user likely to encounter when accomplishing this goal?

<Pain points>

Links to existing content

• <Add link to content>
  

People:

• SME: <SME>
  
• QE: <QE>
  

Release Note: Yes/No

Documentation Outline

• <Documentation outline>