You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org> on 2026/03/14 12:29:48 UTC
[PR] fix(docs): use absolute API doc links in developer docs [superset]
Mayankaggarwal8055 opened a new pull request, #38649:
URL: https://github.com/apache/superset/pull/38649
Fixes #38590
This updates the API links in `docs/developer_docs/api.mdx` from relative `./api/...` paths to absolute `/docs/api/...` paths.
When the developer docs page is opened from a nested URL like `/developer-docs/api/`, the relative links resolve incorrectly and add an extra `api` path segment. Using absolute paths ensures the endpoint documentation links resolve correctly.
## Changes
- Updated markdown links in `docs/developer_docs/api.mdx`
- Replaced broken relative `./api/...` links with absolute `/docs/api/...` links
- Kept the change limited to the affected docs file
## Testing
- Verified the change is limited to `docs/developer_docs/api.mdx`
- Confirmed the updated links no longer depend on the current nested page path
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4134338818
Hi @hainenber,
Thanks again for reviewing and merging this PR — I really appreciate your guidance throughout the process.
If you have a moment, I’d love to get your feedback on my overall approach to this contribution — whether the way I handled the issue, the fixes, or the communication could be improved in any way. I’m trying to get better with each PR, so any suggestions would mean a lot.
Also, if there are any areas you think I should focus on to contribute more effectively going forward, I’d be glad to work on them.
Thanks again for your support!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "michael-s-molina (via GitHub)" <gi...@apache.org>.
michael-s-molina commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4134441500
> Also, if there are any areas you think I should focus on to contribute more effectively going forward, I’d be glad to work on them.
Hi @Mayankaggarwal8055. We really appreciate your latest contributions. We're currently working to release Superset 6.1 and could really use the help to test the RC and submit fixes. Some resources:
- [Project board](https://github.com/orgs/apache/projects/591) for the release with open PRs/issues
- [Testing a Release Candidate (RC)](https://github.com/apache/superset/wiki/Release-Process#testing-a-release-candidate-rc)
- The [6.1.0 RC1](https://github.com/apache/superset/releases/tag/6.1.0rc1) tag
- Or [6.1 branch](https://github.com/apache/superset/tree/6.1) if you prefer to test with the fixes that are already merged and will land in RC2
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060737772
@hainenber
You’re right — the generator script update was missing from the pushed PR. I’ve now pushed the changes to `docs/scripts/generate-api-index.mjs` as well, along with the `api.mdx` fix. Thanks for catching that.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060804597
**Bito Automatic Review Skipped – PR Already Merged**<br/><br/>Bito scheduled an automatic review for this pull request, but the review was skipped because this PR was merged before the review could be run.<br/>No action is needed if you didn't intend to review it. To get a review, you can type `/review` in a comment and save it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4134475216
Hi @michael-s-molina,
Thanks a lot for pointing me in this direction — this is really helpful.
I’ll start testing the 6.1 RC and go through the project board to pick up issues. I’ll also focus on identifying any bugs or improvements, especially around dashboard editing and related areas.
Looking forward to contributing to the release.
Thanks again!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060710991
You are not pushing any changes to `docs/scripts/generate-api-index.mjs` as suggested, though?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060639466
@Mayankaggarwal8055 thanks for opening a PR to address the linked issue! Unfortunately, `/docs/api` absolute URL is not a correct path, it should be `/developer-docs/api` instead. Can you do the replacement?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "netlify[bot] (via GitHub)" <gi...@apache.org>.
netlify[bot] commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060479445
### <span aria-hidden="true">✅</span> Deploy Preview for *superset-docs-preview* ready!
| Name | Link |
|:-:|------------------------|
|<span aria-hidden="true">🔨</span> Latest commit | 14c2ad75c8e7246bd1e55384478cb27c734081be |
|<span aria-hidden="true">🔍</span> Latest deploy log | https://app.netlify.com/projects/superset-docs-preview/deploys/69b554bc1587b90008148397 |
|<span aria-hidden="true">😎</span> Deploy Preview | [https://deploy-preview-38649--superset-docs-preview.netlify.app](https://deploy-preview-38649--superset-docs-preview.netlify.app) |
|<span aria-hidden="true">📱</span> Preview on mobile | <details><summary> Toggle QR Code... </summary><br /><br /><br /><br />_Use your smartphone camera to open QR code link._</details> |
---
<!-- [superset-docs-preview Preview](https://deploy-preview-38649--superset-docs-preview.netlify.app) -->
_To edit notification comments on pull requests, go to your [Netlify project configuration](https://app.netlify.com/projects/superset-docs-preview/configuration/notifications#deploy-notifications)._
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "codeant-ai-for-open-source[bot] (via GitHub)" <gi...@apache.org>.
codeant-ai-for-open-source[bot] commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060477909
## **Sequence Diagram**
This PR updates endpoint links in the developer API documentation from relative paths to absolute docs paths. The new flow ensures clicking any endpoint link from nested developer docs routes always opens the correct API reference page.
```mermaid
sequenceDiagram
participant Reader
participant DeveloperDocsPage
participant DocsRouter
participant ApiReferencePage
Reader->>DeveloperDocsPage: Open developer API docs from nested route
Reader->>DeveloperDocsPage: Click an endpoint link
DeveloperDocsPage->>DocsRouter: Resolve link as absolute docs api path
DocsRouter->>ApiReferencePage: Navigate to endpoint documentation
ApiReferencePage-->>Reader: Display correct API reference page
```
---
*Generated by [CodeAnt AI](https://codeant.ai)*
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber merged PR #38649:
URL: https://github.com/apache/superset/pull/38649
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060703154
@hainenber Fixed! Pushed correct paths:
✅ docs/developer_docs/api.mdx: `/docs/api/` → `/developer-docs/api/` (242 links)
✅ docs/scripts/generate-api-index.mjs: `./api/` → `/developer-docs/api/`
Netlify preview will update shortly. Thanks! 🙏
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "hainenber (via GitHub)" <gi...@apache.org>.
hainenber commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060656776
btw, you'll need to change the absolute path in the script used to generate the `api.mdx` as well, for future APIs.
```
diff --git a/docs/scripts/generate-api-index.mjs b/docs/scripts/generate-api-index.mjs
index e5f6a7e693..2fd9fddac6 100644
--- a/docs/scripts/generate-api-index.mjs
+++ b/docs/scripts/generate-api-index.mjs
@@ -202,7 +202,7 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\
mdx += `| Method | Endpoint | Description |\n`;
mdx += `|--------|----------|-------------|\n`;
for (const ep of tagEndpoints['Security']) {
- mdx += `| \`${ep.method}\` | [${ep.summary}](./api/${ep.slug}) | \`${ep.path}\` |\n`;
+ mdx += `| \`${ep.method}\` | [${ep.summary}](/developer-docs/api/${ep.slug}) | \`${ep.path}\` |\n`;
}
mdx += '\n';
renderedTags.add('Security');
@@ -229,7 +229,7 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\
mdx += `|--------|----------|-------------|\n`;
for (const ep of endpoints) {
- mdx += `| \`${ep.method}\` | [${ep.summary}](./api/${ep.slug}) | \`${ep.path}\` |\n`;
+ mdx += `| \`${ep.method}\` | [${ep.summary}](/developer-docs/api/${ep.slug}) | \`${ep.path}\` |\n`;
}
mdx += `\n</details>\n\n`;
@@ -252,7 +252,7 @@ curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \\
mdx += `|--------|----------|-------------|\n`;
for (const ep of endpoints) {
- mdx += `| \`${ep.method}\` | [${ep.summary}](./api/${ep.slug}) | \`${ep.path}\` |\n`;
+ mdx += `| \`${ep.method}\` | [${ep.summary}](/developer-docs/api/${ep.slug}) | \`${ep.path}\` |\n`;
}
mdx += `\n</details>\n\n`;
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060695776
@hainenber Perfect catch! Fixing now:
✅ docs/developer_docs/api.mdx: `/docs/api/` → `/developer-docs/api/`
✅ docs/scripts/generate-api-index.mjs: Update auto-generation script
Pushing corrected paths in 3 minutes. Thanks! 🙏
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "Mayankaggarwal8055 (via GitHub)" <gi...@apache.org>.
Mayankaggarwal8055 commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060481671
@maintainers I’ve opened this docs fix for #38590. The change is limited to `docs/developer_docs/api.mdx` and updates the broken relative links to absolute paths. I’d appreciate a review when possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
Re: [PR] fix(docs): use absolute API doc links in developer docs [superset]
Posted by "bito-code-review[bot] (via GitHub)" <gi...@apache.org>.
bito-code-review[bot] commented on PR #38649:
URL: https://github.com/apache/superset/pull/38649#issuecomment-4060476700
AI Code Review is in progress (usually takes 3 to 15 minutes unless it's a very large PR).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org