Skip to content
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

docs: fix links #26606

Merged
merged 3 commits into from
Jan 16, 2024
Merged

docs: fix links #26606

merged 3 commits into from
Jan 16, 2024

Conversation

fenilgmehta
Copy link
Contributor

SUMMARY

Fix link to docker_build_push.sh in docs/docs/installation/installing-superset-from-scratch.mdx
Fix syntax of link to setup.py file in docs/docs/installation/installing-superset-from-scratch.mdx

Fix links in multiple doc pages so that they take us to the locally hosted URL when we run the docs using the below commands

cd docs
npm run start

TESTING INSTRUCTIONS

Start local version of docs using the below commands

cd docs
npm run start

Visit http://localhost:3000/docs/installation/installing-superset-from-scratch

Before the fix - setup.py was shown as plain text
image

After the fix - setup.py is highlighted as a link
Screenshot from 2024-01-14 17-12-38

Clicking on this file link on the same page should take us to a valid file on the GitHub.
image

Clicking on Configuring Superset should take us to http://localhost:3001/docs/installation/configuring-superset instead of https://superset.apache.org/docs/installation/configuring-superset/ . We can test other pages in the same way.
image

Copy link
Member

@sfirke sfirke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks for these fixes. And nice catch on the wrong formatting on that setup.py link and the other broken link.

@sfirke sfirke merged commit 2e17a9e into apache:master Jan 16, 2024
29 checks passed
@sfirke
Copy link
Member

sfirke commented Jan 16, 2024

Thanks @fenilgmehta for a great clean contribution! The way you shared screenshots and examples in the PR was very helpful 🙏

@fenilgmehta fenilgmehta deleted the fix-internal-doc-links branch February 28, 2024 04:26
sfirke pushed a commit to sfirke/superset that referenced this pull request Mar 22, 2024
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.0.0 labels Apr 17, 2024
vinothkumar66 pushed a commit to vinothkumar66/superset that referenced this pull request Nov 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants