issue-511: Changed RBAC links in MD to absolute references to md file #512
Conversation
Signed-off-by: Joe Pearson <[email protected]>
There was a problem hiding this comment.
Full path directory links will definitely work for the Open Horizon documentation.
Maybe the only reason these were all relative paths is because the downstream IBM documentation has a different directory structure. It was easier to keep pages in sync. Not certain it matters.
I changed my mind from Approve to Comment because if you're making changes to just the rbac link, there are many many others that are relative paths.
What problem are you trying to solve. These 6 edits might be unnecessary.
There was a problem hiding this comment.
I agree with this top level change to dir.md
There was a problem hiding this comment.
This proposed change in multi_tenancy.md is not necessary. The relative link works fine. There are other relative links in this file that also work fine.
There was a problem hiding this comment.
This proposed change in administering_index.html is not necessary. The relative link works fine. There are other relative links in this file that also work fine.
Possibly change /rbac/ to rbac.md
There was a problem hiding this comment.
maybe this link should be relative but ../../user_management/rbac.md instead of a dangling /rbac
The link DOES work fine when you visit https://open-horizon.github.io/docs/developing/secrets_details/
There was a problem hiding this comment.
Both gdpr.md and rbac.md are in the same directory. The full path isn't necessary. The link to rbac works fine on https://open-horizon.github.io/docs/user_management/gdpr/
There was a problem hiding this comment.
This is a slippery slope. Other relative links are on this page. No reason to change the rbac link. The pages load fine at https://open-horizon.github.io/docs/user_management/security/
|
Overall, I think this PR needs to be carefully reconsidered. Its a slippery slope. It doesn't actually fix any problems and creates inconsistency. |
|
If we're solving for the Orphan Pages report, something is more fundamentally broken with that GHA. The rbac page is linked to from 6 other pages. |
|
OK, good points, closing. |
Pull Request Template
Description
In one HTML file, I changed the rbac reference from .html to the folder link. In 5 markdown files, I changed the ambiguous relative path to the MD file into an absolute reference to the path:
Was:
../../user_management/rbac.mdNow:
/docs/user_management/rbac.mdFixes #511
Type of change
Please delete options that are not relevant.
...
Checklist:
@johnwalicki FYI ...