oracle / oracle/macaron

Add a tutorial for proprietary use cases

Open
#557 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
210
Forks
36
Avg merge
1d 10h
Merged PRs (30d)
2

Description

We need to add a tutorial for a proprietary use case where a self-hosted GitLab instance is used as the version control and CI service, Witness is used for generating provenances, and JFrog is used as an artifactory for storing the provenances and artifacts.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the existing tutorial documentation and reviewing how Macaron documents CI/CD, provenance generation, and artifact storage. Use the requested self-hosted GitLab, Witness, and JFrog workflow as the scope, and consider the tutorial complete when it explains that proprietary use case end to end.

Written by the indexing model from the issue text.

Assessment

Tech stack
gitlab, python
Domain
build-system, devops, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.