Document how to include lookups in contentctl content packs

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

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Review the existing contentctl documentation and the content pack lookup handling described by the issue. Document that a lookup requires both a YAML file and a CSV file in the lookups folder, including setup guidance. Done when a newcomer can configure lookups without reading the code.

Written by the indexing model from the issue text.

Description

Hi! I was looking into how to include lookups in a contentctl content pack. I finally found how to do it

(you need to include two files, a YAML one and a CSV one in the lookups folder)

However, I had to read a lot of code to figure this out. This could use some documentation to help people set it up :)

Dominant language
Python
Stars
139
Forks
52
Avg merge
1h 16m
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

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.

More from splunk/contentctl

All issues in splunk/contentctl

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.