pulp / pulp/pulp-docs

When searching for Changelog, the results don't specify what component they are for

Open
#62 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Description

We need to make it so that when searching for "Changelog" I can tell what component each "Changelog" in the list of results is for.

Since changelogs are auto-generated, this could probably be handled via the plugin_template?

The following screenshot illustrates the problem:

pulp_changelog_naming

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 inspecting the plugin_template and the generated changelog output used by search results. Reproduce a search for "Changelog" and trace how each result is labeled; the work is done when every result identifies its component clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.