search

openSUSE / obs-docu

Official Open Build Service Documentation. Content gets reviewed and edited. Generated books are available at http://www.openbuildservice.org
34 stars 70 forks source link

Cross reference improvement #314

Closed rjschwei closed 8 months ago

rjschwei commented 9 months ago

Issue Description

The Source Management chapter in the section about SBOM generation contains the following information:

""" Please check the build config documentation for the sbom flag. """

But there is no chapter or section titled "build config" that the user can easily find from the "Contents" menu.

Expected Result

Make "build config documentation" a link to the appropriate section in the document or change the wording to match a chapter and section such that the user can easily navigate to the relevant information.

How to Reproduce

  1. Go to https://openbuildservice.org/help/manuals/obs-user-guide/cha.obs.source_management#id-1.5.10.6.5
  2. Click on 'Generating SBOM (Software Bill Of Material) Data'
  3. You will see the sentence referenced above.
smithfarm commented 8 months ago

@rjschwei I opened a PR - #316 - to fix this. Can you comment there/review it?

smithfarm commented 8 months ago

image