Link to edit Superset /docs/intro page on GitHub is broken

dwgrossberg commented 2 days ago

Bug description

The bug is as follows:

Go to the Superset documentation landing page (https://superset.apache.org/docs/intro)
Click on the pop-up button titled "Edit this page on GitHub"
The linked GitHub page is not found (404 - "The master branch of superset does not contain the path docs/docs/intro.md.")

Screenshots/recordings

Superset version

master / latest-dev

Python version

Not applicable

Node version

Not applicable

Browser

Chrome

Additional context

No response

Checklist

[X] I have searched Superset docs and Slack and didn't find a solution to my problem.
[X] I have searched the GitHub issue tracker and didn't find a similar bug report.
[X] I have checked Superset's logs for errors and if I found a relevant Python stacktrace, I included it here as text in the "additional context" section.

dosubot[bot] commented 2 days ago

Hey there, @dwgrossberg! I'm here to help you with any bugs, questions, or contributions related to Superset. Looking forward to assisting you!

A similar issue was previously reported and closed, which involved a broken link in the top-level documentation ^[1]. The problem you're experiencing with the "Edit this page on GitHub" link likely stems from the editUrl configuration in the docusaurus.config.js file. The editUrl is set to 'https://github.com/apache/superset/edit/master/docs', which might not match the current file structure if the intro.md file has been moved or renamed ^[2].

To resolve this, you may need to verify the actual location of the intro.md file in the repository and update the editUrl configuration accordingly. If the file path has changed, updating the editUrl to reflect the new path should fix the broken link issue.

To continue talking to Dosu, mention @dosu.

rusackas commented 1 day ago

OK, I'll try to take a look at some point in the future, but it's not likely to get prioritized soon. A PR would be appreciated if you're so inclined.

Meanwhile, the docs page is somehow including the README.md file there, if you want to make any changes there.

apache / superset