carvel-dev / carvel-dev/imgpkg

[Docs] Pulling a nested bundle should allow filtering

Open
#119 0 comments 0 reactions 0 assignees View on GitHub
carvel accepted documentation priority/unprioritized-backlog
Dominant language
Go
Stars
284
Forks
70
PR merge metrics
No merged PRs in 30d

Description

# Use Case
As an Application consumer
When filtering nested bundles
I want to read friendly, easy to learn documentation
So that I learn about the capabilities of the pull command
And so that I can easily use / debug / fix any issues using the tool

# Description

📚 Documentation: Navigation
Given I want to learn how to filter a nested bundle
When I navigate through imgpkg documentation
Then I intuitively find the reference that describes the pull command and the --recursive-filter flag

🔍 Documentation: Search
Given I want to learn how to filter a nested bundle
When I search for the most obvious search terms: "recursive", "nested bundles", "filter"
Then I see results that when I click on them take me to the most relevant reference for this flag.

Contributor guide

Open the contributing guide

Research direction

Start by locating the imgpkg pull-command reference and the --recursive-filter documentation, then check how documentation navigation and search terms are defined. Done means users can find the nested-bundle filtering reference through navigation and searches for “recursive,” “nested bundles,” and “filter,” with the flag’s behavior explained clearly.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.