Fix links in "See also" section of the API docs. #291
Merged
Conversation
This file contains 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
@garg3133 Review Requested. I have been investigating to find any hard-coded redirect but there are none and entire docs have been updated with `/guide`. Afterwards, I found that there is if-else logic running for "See Also" section at, `nightwatch-docs/src/includes/api-method.ejs` In that, the line, `<li><code><a href="<%- appSettings.baseUrl.replace(/\/$/, '') -%>/api/<%- link.split('.').join('/') %>.html"><%= link %></a></code></li>` generates link accordingly. Now, after many workarounds, I cannot seem to budge the extra two dots that, `appSettings.baseUrl.replace(/\$/,'')` is appending after ".org" domain. I tried: [-] Slicing after replace with (0,-2), but instead of removing double dots, it gives out: https://nightwatchjs.o../<other-parts-of-url> [-] Writing new logic: Gives out same result I found that, replace() method is creating the problems. Simply removing it, works. Additionally, I added "/" in the BASE_URL in postdoc config. Do tell me if this is not right, or should I seek another way to solve the problem?
|
@ParmarKrishna Your solution does not seem to be working for me. Maybe you can try removing the complete baseUrl itself from the |
@garg3133 Review Requested. As per your suggestion, removing entire appSettings.baseUrl works. Pages seem to be redirected with directly `api`
|
@garg3133 Review Requested. As per your suggestion, removing entire baseUrl does work fine, for all the "See Also" sections. I did:
It works. Do let me know if this solution works for you, or should I look for other ways? PR #291 has been pushed with the changes. |
garg3133
reviewed
Mar 27, 2024
Adding the empty line at, line 19.
garg3133
changed the title
|
The PR title should contain a brief on what this PR does instead of just writing the issue number. |
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.
@garg3133 Review Requested.
I have been investigating to find any hard-coded redirect but there are none and entire docs have been updated with
/guide.Afterwards, I found that there is if-else logic running for "See Also" section at,
nightwatch-docs/src/includes/api-method.ejsIn that, the line,
<li><code><a href="<%- appSettings.baseUrl.replace(/\/$/, '') -%>/api/<%- link.split('.').join('/') %>.html"><%= link %></a></code></li>generates link accordingly.Now, after many workarounds, I cannot seem to budge the extra two dots that,
appSettings.baseUrl.replace(/\$/,'')is appending after ".org" domain.I tried:
[-] Slicing after replace with (0,-2), but instead of removing double dots, it gives out: https://nightwatchjs.o../
[-] Writing new logic: Gives out same result
I found that, replace() method is creating the problems. Simply removing it, works. Additionally, I added "/" in the BASE_URL in postdoc config.
Do tell me if this is not right, or should I seek another way to solve the problem?