pulp / pulp/pulp-docs

Changes fragments with linebreaks breaks display

Open
#171 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Mkdocs doesn't handle the line breaks in the bullet items well.
In those occasions, the display seems to break.

In markdown

- Fixed a bug where syncing from a remote repository with duplicate filenames and different paths
  would result in one of these packages being missing from a Pulp distribution.
  This is known to happen in some JFrog repositories.

  On systems that have synced from such repositories before, it is required to clean up the related
  packages with orphan cleanup or use the provided "pulpcore-manager rpm-datarepair 4073",
  which forces internal objects to use non-ambiguous filenames.
  [#4073](https://github.com/pulp/pulp_rpm/issues/4073)
- Taught publish/synchronize to return full serialized object of their action.
  [#4117](https://github.com/pulp/pulp_rpm/issues/4117)
- Fix a bug where the `retain_package_versions` feature (and prune and a few others) was not correctly determining which packages were most recent.
  [#4124](https://github.com/pulp/pulp_rpm/issues/4124)

https://github.com/pulp/pulp_rpm/blob/1282d25420960281c01025cd35b9862a8b450865/CHANGES.md?plain=1#L49-L57

Display

Image

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 with the affected CHANGES.md section at lines 49-57 and compare its Markdown source with the displayed result in the attached image. Reproduce the rendering issue using the multiline bullet examples, then verify that the affected changelog entries display correctly without breaking their list structure.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.