conda-forge.github.io icon indicating copy to clipboard operation
conda-forge.github.io copied to clipboard

Make external links to open in a new tab

Open codewithmike01 opened this issue 2 years ago • 8 comments

Where should the content be added?

https://conda-forge.org/docs/user/contributing.html

What should be added?

  • I noticed that all external links in the documentation do not open in a new tab, I think it should be best to open all external links like the GitHub doc link in a new tab so as to keep the user on the conda-forge doc and aid easy navigation.
  • Also I noticed some terms are outdated like that of the branch name as master instead of main

Additional information

codewithmike01 avatar Apr 18 '22 22:04 codewithmike01

@kathatherine @beckermr if this issue is good enough, I will like to commence work on fixing it.

Please I need your view on this. Thank you.

codewithmike01 avatar Apr 22 '22 16:04 codewithmike01

@Ginohmk I think we have a PR out there that renames all instances of "master" to "main", so don't worry about that. I would agree that it would be great to have all external links open in a new tab. Just the external links, though. For all links within the conda-forge docs, it would be better to let the user choose.

kathatherine avatar Apr 22 '22 17:04 kathatherine

@kathatherine thanks for your reply. From what you suggested. Can I work on making just the external links open in a new tab ?

codewithmike01 avatar Apr 22 '22 17:04 codewithmike01

@Ginohmk Yes, yes. You are welcome to work on it. I don't have the permissions to assign you, but with any issue, you can just say, "I'm going to work on this" so everyone's aware and then get started.

kathatherine avatar Apr 22 '22 17:04 kathatherine

Much Thanks @kathatherine

I am going to work on this issue

codewithmike01 avatar Apr 22 '22 17:04 codewithmike01

hi @kathatherine . I have done my research on this issue. It is possible to implement, but it might change lots of codes in the config.py and that might affect the operation of the documentation. would you prefer I proceed with it or just let go of the issue and fix something else?
How it might be done

Also, the external link on the new tab is a feature currently worked on Link

so do you suggest I leave this issue for now until a safe approach is discovered other than editing the config file?

codewithmike01 avatar Apr 25 '22 16:04 codewithmike01

@Ginohmk Hmm, good to know. Thank you for your research on this. It does seem rather painful to implement. Adding javascript to the conf.py would affect every link, I'm assuming, and we don't want that and I'd also like to avoid adding raw HTML everywhere in the docs, as it would really clutter things up. I think it would be best to leave the issue for now.

kathatherine avatar Apr 25 '22 16:04 kathatherine

You are welcome @kathatherine . I thought of the complications attached to implementing it now with javascript, and it's something that would not seat right with the previous code structure. Hopefully, in the future, it would be an added feature that can be implemented easily :) And thanks for your quick reply. I will scan through the issues available and see if I can work on something else. Thank you.

codewithmike01 avatar Apr 25 '22 16:04 codewithmike01