Clean up topic page labels and link hierarchy#859
Open
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
Open
Clean up topic page labels and link hierarchy#859PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
PRAteek-singHWY wants to merge 1 commit intoOWASP:mainfrom
Conversation
Contributor
Author
|
Hi @robvanderveer @northdpole @Pa04rth, sharing this PR for #186. I implemented the requested topic-page cleanup items (wording updates, hierarchy label/order changes, default collapse for related topics, and reference icon improvements). Could you also please confirm whether #186 is still considered active/relevant in the current roadmap? Happy to make any refinements based on your feedback. Thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
fixes #186
Implements topic-page clarity improvements requested in #186 by reducing CRE jargon, improving hierarchy wording, and making topic navigation clearer.
Scope
What Changed
is linked to sources->refers to sourcesis part of ...->is child of ...is linked from ...->is referenced by ...CREsphrasing in link-section labels withRequirementsLinked Toappears beforeContainsRelatedtopic nodes collapse by defaultFiles Changed
application/frontend/src/const.tsapplication/frontend/src/utils/document.tsapplication/frontend/src/components/DocumentNode/DocumentNode.tsxapplication/frontend/src/components/DocumentNode/documentNode.scssapplication/frontend/src/pages/Explorer/explorer.tsxapplication/frontend/src/pages/CommonRequirementEnumeration/CommonRequirementEnumeration.tsxapplication/frontend/src/providers/DataProvider.tsxManual Verification (Before vs After)
1) Topic page basic cleanup
Path
https://www.opencre.org/cre/546-564http://localhost:9001/cre/546-564Verify
CRE: 546-564ID: 546-564CRE : 028-727 : CSRF protectionCSRF protectionWhich contains CREsWhich contains RequirementsScreenshots
Before:After:2) Wording + related behavior + topic naming
Path
https://www.opencre.org/cre/155-155http://localhost:9001/cre/155-155Verify
Which is linked to sourcesWhich refers to sourcesWhich is part of CREsWhich is child of RequirementsCRE : xxx-xxxprefixScreenshots
before:after:3) Block order (Linked first, Contains below)
Path
https://www.opencre.org/cre/326-704http://localhost:9001/cre/326-704Verify
refers to sourcesblockcontains RequirementsblockScreenshots
before:after:4) Standard-page wording
Path
https://www.opencre.org/node/standard/OWASP%20Top%2010%202021/section/Insecure%20Designhttp://localhost:9001/node/standard/OWASP%20Top%2010%202021/section/Insecure%20DesignVerify
Which is linked from CREsWhich is referenced by RequirementsScreenshots
before:after:5) Explorer list cleanup
Path
https://www.opencre.org/explorerhttp://localhost:9001/explorerVerify
546-564:Screenshots
before: [after:Notes
tags:line is not explicitly present in current tested pages; no direct removal hook was required in this patch.