You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by "fenilgmehta (via GitHub)" <gi...@apache.org> on 2024/01/14 11:55:30 UTC

[PR] docs: fix links [superset]

fenilgmehta opened a new pull request, #26606:
URL: https://github.com/apache/superset/pull/26606

   ### 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
   
   ```bash
   cd docs
   npm run start
   ```
   
   ### TESTING INSTRUCTIONS
   
   Start local version of docs using the below commands
   
   ```bash
   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](https://github.com/apache/superset/assets/42742240/587bd065-23a7-4254-aede-ea40c50bbdd2)
   
   After the fix - `setup.py` is highlighted as a link
   ![Screenshot from 2024-01-14 17-12-38](https://github.com/apache/superset/assets/42742240/9bcc0ac2-58e6-4c99-ab33-764e0b64af58)
   
   Clicking on `this file` link on the same page should take us to a valid file on the GitHub.
   ![image](https://github.com/apache/superset/assets/42742240/31480cb7-4be7-44a8-9da2-baac9fd499db)
   
   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](https://github.com/apache/superset/assets/42742240/ca7b8a71-74fa-40e6-8f1d-0ef5c99b8ea3)
   


-- 
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] docs: fix links [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke commented on PR #26606:
URL: https://github.com/apache/superset/pull/26606#issuecomment-1894477522

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


-- 
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] docs: fix links [superset]

Posted by "sfirke (via GitHub)" <gi...@apache.org>.
sfirke merged PR #26606:
URL: https://github.com/apache/superset/pull/26606


-- 
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