Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-10441

Improving storage documentation

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Unresolved
    • Icon: Undefined Undefined
    • None
    • None
    • Tekton Chains
    • None
    • 3
    • False
    • Hide

      None

      Show
      None
    • False
    • Pipelines Sprint CrookShank 46

      Story (Required)

      A follow up task to the code coverage in Chains that was done. (SRVKP-9408).

      Includes 3 steps:

      1. setting up a local Mongodb server, and change the url to test the fix for bug #1178 is working --REMOVED from this tasks workload
      2. Creating a docdb tutorial. How to use, what artifacts are included, what are the backend options, what is stored in these artifacts etc.. ) specifically to MongoDB. An example for tutorial structure and content can be found here: https://github.com/tektoncd/chains/blob/main/docs/tutorials/provenance-storage-gcs-tutorial.md PR to chains/docs/tutorials
      3. Write a storage section blog that shall be added here- https://tekton.dev/docs/chains/ Blog shall cover general data on docdb storage (a comparison between all option?). PR to tektoncd/website/content/en/blog/2025

      Background (Required)

      Adding documentation to raise topics coverage in chains docs.

      Out of scope

      <Defines what is not included in this story>

      Approach (Required)

      <Description of the general technical path on how to achieve the goal of the story. Include details like json schema, class definitions>

      Dependencies

      <Describes what this story depends on. Dependent Stories and EPICs should be linked to the story.>

      Acceptance Criteria (Mandatory)

      <Describe edge cases to consider when implementing the story and defining tests>

      <Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story>

      INVEST Checklist

      Dependencies identified

      Blockers noted and expected delivery timelines set

      Design is implementable

      Acceptance criteria agreed upon

      Story estimated

      Legend

      Unknown

      Verified

      Unsatisfied

      Done Checklist

      • Code is completed, reviewed, documented and checked in
      • Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      • Continuous Delivery pipeline(s) is able to proceed with new code included
      • Customer facing documentation, API docs etc. are produced/updated, reviewed and published
      • Acceptance criteria are met

              rh-ee-ngelman Naomi Gelman
              rh-ee-ngelman Naomi Gelman
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: