Skip to content

feat: Make OBS user documentation more visible#19279

Open
Sahitya0805 wants to merge 1 commit intoopenSUSE:masterfrom
Sahitya0805:feature/visible-documentation
Open

feat: Make OBS user documentation more visible#19279
Sahitya0805 wants to merge 1 commit intoopenSUSE:masterfrom
Sahitya0805:feature/visible-documentation

Conversation

@Sahitya0805
Copy link
Contributor

@Sahitya0805 Sahitya0805 commented Feb 14, 2026

Hey friends!

I’ve extended the contextual documentation approach to a few key configuration-related pages to demonstrate the pattern clearly. This ensures that users have immediate access to relevant help documentation directly from the most critical project settings screens.

Pages updated in this PR:

Project Configuration: Verified and aligned with the existing pattern.
Build Configuration: Added a "Documentation ↗" link near the page title.
Label Templates: Added a "Documentation ↗" link near the page title.
This change improves consistency across the configuration interface and helps users navigate complex settings with direct links to the OBS User Guide. If this direction looks good, I can continue applying the same approach to other relevant pages.

Here is a screenshot of how it looks:

Screenshot 2026-02-27 at 7 26 32 PM Screenshot 2026-02-27 at 7 27 10 PM Screenshot 2026-02-27 at 7 39 35 PM

@github-actions github-actions bot added the Frontend Things related to the OBS RoR app label Feb 14, 2026
@Sahitya0805 Sahitya0805 force-pushed the feature/visible-documentation branch from 3344bae to 39b8615 Compare February 14, 2026 06:31
@github-actions github-actions bot added the Test Suite / CI 💉 Things related to our tests/CI label Feb 14, 2026
@Sahitya0805 Sahitya0805 force-pushed the feature/visible-documentation branch 3 times, most recently from 571c75d to 983b8ed Compare February 14, 2026 08:00
@Sahitya0805 Sahitya0805 marked this pull request as ready for review February 14, 2026 08:38
@hennevogel
Copy link
Member

Please mind https://github.com/openSUSE/open-build-service/blob/master/CONTRIBUTING.md#proper-pull-request

Especially:

  • If you include visual changes in this PR, please add screenshots or GIFs

@hennevogel
Copy link
Member

Screen Shot 2026-02-20 at 12 44 11

@hennevogel
Copy link
Member

hennevogel commented Feb 20, 2026

I'm not convinced that just adding a second link to the documentation in the upper navigation is helping anything. Other opinions?

@Sahitya0805
Copy link
Contributor Author

Thanks for the feedback, that makes sense

Instead of adding a new icon, I can try some simpler options:

• Add the documentation link inside an existing menu (like the user dropdown or settings) so it’s easier to find without adding extra UI
• Move the link from the footer to the header instead of keeping it in both places
• Or show the documentation link only on important pages like the dashboard where new users might need it

I’m happy to update the PR in whichever way fits the project best

@hennevogel
Copy link
Member

hennevogel commented Feb 23, 2026

What would make most sense is to add links to relevant sections of the documentation to certain pages. Like adding a link to the Build Configuration section to the /projects/:project_name/prjconf page. Or adding a link to the Labels section to the /projects/:project_name/label_templates page etc. etc.

@Sahitya0805 Sahitya0805 force-pushed the feature/visible-documentation branch from 983b8ed to a111ce3 Compare February 26, 2026 04:21
@Sahitya0805 Sahitya0805 marked this pull request as draft February 26, 2026 04:31
@Sahitya0805 Sahitya0805 marked this pull request as ready for review February 26, 2026 17:56
@Sahitya0805
Copy link
Contributor Author

Thanks for the feedback! I’ve updated the PR and replaced the global help icon with a contextual documentation link on the project configuration page.
Let me know if this feels like the right direction, and I can apply the same approach to the other pages as well.

@Pittu-Sharma
Copy link

Thanks for the update, this looks like the right direction

The contextual documentation link on the project configuration page makes sense and feels more intuitive than the global help icon.

Yes, please go ahead and apply the same approach to the other relevant pages as well.

@Pittu-Sharma
Copy link

Pittu-Sharma commented Feb 27, 2026 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Frontend Things related to the OBS RoR app Test Suite / CI 💉 Things related to our tests/CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants