-
Notifications
You must be signed in to change notification settings - Fork 7
Fix links VS version in hub cards #288
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
Draft
adriendupuis
wants to merge
9
commits into
5.0
Choose a base branch
from
card-version-js
base: 5.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
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
|
This was referenced Apr 19, 2024
Closed
7 tasks
Of course, it also happens on developer doc (see ibexa/documentation-developer#2541). |
Preview of modified files: no change to preview. |
|
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.
Bug
Example:
https://doc.ibexa.co/projects/userguide/en/4.5/persona_paths/author_content/ "Edit image"
In persona_paths/author_content.md, content_management/edit_images/ refers to 4.5 file which doesn't exist on master or 4.6 (moved to image_management/edit_images/).
Solution Comparison
href
attribute which is good for Ibexa DXP editions > Ibexa Headless documentation-developer#2242 if ported to dev doc. At least, it cleans up the code a bit.cards
already existing feature to force4.5
from4.5
branch. Success on production but breaks the link on localhost which could disturb doc writers. The fix must be installed on each branch except the one corresponding tolast
(actually4.6
but this will change). Too hard to maintain.When on projects/userguide/en//persona_paths/author_content/
"✅ Yes": The "Edit images" link leads to the expected location.
"✔️ Yes, but…": The "Edit images" link works but leads to a less accurate location (change the server and/or the version). Weak links that break as soon as
master
differs fromlatest
.":x: No": The "Edit images" is broken.
latest
Production4.5
Production4.5
ReadTheDocs4.5
localhostmaster
Productionmaster
ReadTheDocsmaster
localhost"
latest
Prodution": https://doc.ibexa.co/projects/userguide/en/latest/persona_paths/author_content/"
4.5
Production": https://doc.ibexa.co/projects/userguide/en/4.5/persona_paths/author_content/"
master
Production": https://doc.ibexa.co/projects/userguide/en/master/persona_paths/author_content/"
master
ReadTheDocs": The preview of a pull request frommaster
tomaster
"
4.5
ReadTheDocs": The preview of a pull request from4.5
branch to4.5
"
master
localhost": The local run ofmkdocs serve
on branchmaster
Fix
#287 + #271
https://doc.ibexa.co/projects/userguide/en/4.5/persona_paths/author_content/ example:
href="/projects/userguide/en/latest/content_management/edit_images"
card.js
sees it as an internal link and replace it withhref="/projects/userguide/en/4.5/content_management/edit_images"
https://ez-systems-developer-documentation--288.com.readthedocs.build/projects/userguide/en/288/persona_paths/author_content/
href="/projects/userguide/en/latest/image_management/edit_images"
card.js
sees it as an internal link and replace it withhref="/projects/userguide/en/288/image_management/edit_images"
Checklist