DOC add link to raise issue

[romanlutz]

Describe the issue linked to the documentation

In today's community call, the idea was brought up (by @MiroDudik or @hildeweerts , I forget...) to add a link on example notebooks to raise an issue. This should make it easy for readers to raise issues without having to navigate to our repo first and then copy-paste links to the correct notebook etc.

Suggest a potential alternative/fix

There's no feature in sphinx-gallery that does that automatically BUT I found this is the pytorch docs:

raw.githubusercontent.com/pytorch/tutorials/3e9e8f68cc904f9eb37c862348cc2216611faadd/intermediate_source/ddp_tutorial.rst

.. note::
   |edit| View and edit this tutorial in `github <https://github.com/pytorch/tutorials/blob/main/intermediate_source/ddp_tutorial.rst>`__.

So this would just be a highlighted box with a link and we'd have to make sure the link is correct. The file names rarely change so it wouldn't be hard to maintain over time, though.

Thoughts @fairlearn/fairlearn-maintainers ?

[hildeweerts]

Sounds like a fine and not too overengineered solution to me! :)

[Hrittik20]

Hello @romanlutz! Just to confirm, do I need to add this to only "Example Notebooks" page?

[romanlutz]

It needs to be added to every single notebook I would imagine.

[Hrittik20]

@romanlutz So I need to put the links to the appropriate notebooks, right? For example, for contributing example notebook, I need to use this link "https://github.com/fairlearn/fairlearn/blob/main/docs/contributor_guide/contributing_example_notebooks.rst"

[romanlutz]

I was thinking more along the lines of linking to the code file in the repo. Once you are there you can hit edit and create a branch with your changes.

But what you're saying has merit, too. For most people it's probably advisable to first file an issue and ask if the changes are meant to happen instead of doing all the work for a PR.

We could do both...

[hildeweerts]

Perhaps we can add two links, 'view source' to the code file and 'open issue' (with a link like https://github.com/fairlearn/fairlearn/issues/new?title=DOC%20Issue%20blabla&body=blabla.)