Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test to check Satellite documention links for GA'ed Satellite #16812

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

jameerpathan111
Copy link
Contributor

Problem Statement

Historically, after a Satellite release, we have found that the documentation links on Satellite pages were broken, causing bugs and customer cases to be filed, resulting in a poor user experience.

Solution

Related Issues

@jameerpathan111 jameerpathan111 added CherryPick PR needs CherryPick to previous branches Stream Introduced in or relating directly to Satellite Stream/Master 6.16.z Introduced in or relating directly to Satellite 6.16 labels Oct 29, 2024
@jameerpathan111 jameerpathan111 self-assigned this Oct 29, 2024
@jameerpathan111
Copy link
Contributor Author

jameerpathan111 commented Oct 29, 2024

Tested the code locally with Satellite 6.15 and found 3 broken links. Filed SAT-29022 and SAT-28994.

Copy link
Contributor

@lpramuk lpramuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK with small nitpick 😉

tests/foreman/ui/test_documentation_links.py Outdated Show resolved Hide resolved
Copy link
Contributor

@pondrejk pondrejk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ack, minor comment

'jobinvocation',
'audit',
'factvalue',
'dashboard',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

slightly concerned about keeping this list up to date

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't think of better approach atm:/

Copy link
Contributor

@rmynar rmynar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. But agree with previous comments... It will be hard to maintain the list of pages. Ideas how to improve that are welcome.
What about AutoMergeCherrypicked label?

@jameerpathan111
Copy link
Contributor Author

Approved. But agree with previous comments... It will be hard to maintain the list of pages. Ideas how to improve that are welcome. What about AutoMergeCherrypicked label?

I'm not sure if auto merge works on PR's without PRT comment. We can try though.

@jameerpathan111 jameerpathan111 added Auto_Cherry_Picked Automatically cherrypicked PR using GHA AutoMerge_Cherry_Picked The cherrypicked PRs of master PR would be automerged if all checks passing and removed Auto_Cherry_Picked Automatically cherrypicked PR using GHA labels Oct 31, 2024
@rmynar rmynar merged commit 24dce9f into SatelliteQE:master Oct 31, 2024
11 checks passed
github-actions bot pushed a commit that referenced this pull request Oct 31, 2024
pondrejk pushed a commit that referenced this pull request Nov 4, 2024
…llite (#16825)

Add test to check Satellite documention links for GA'ed Satellite (#16812)

(cherry picked from commit 24dce9f)

Co-authored-by: Jameer Pathan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.16.z Introduced in or relating directly to Satellite 6.16 AutoMerge_Cherry_Picked The cherrypicked PRs of master PR would be automerged if all checks passing CherryPick PR needs CherryPick to previous branches Stream Introduced in or relating directly to Satellite Stream/Master
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants