You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Joris Van den Bossche (Jira)" <ji...@apache.org> on 2022/06/09 16:05:00 UTC

[jira] [Commented] (ARROW-16798) [Docs] Link from docs pages to associated RST files in GitHub

    [ https://issues.apache.org/jira/browse/ARROW-16798?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17552289#comment-17552289 ] 

Joris Van den Bossche commented on ARROW-16798:
-----------------------------------------------

There is already a "Edit this page" button, for example:

 !screenshot-1.png! 

And that links to the github page (although for API reference pages for pyarrow, it will point to a nonexistent page ..).

We could make this more visible / expanded? 
For example the MDN docs include a text box with more info at the bottom of each page: https://developer.mozilla.org/en-US/docs/Web/CSS/Cascade#see_also (of course you also only see that if you scrolled down until the bottom of the page)

> [Docs] Link from docs pages to associated RST files in GitHub
> -------------------------------------------------------------
>
>                 Key: ARROW-16798
>                 URL: https://issues.apache.org/jira/browse/ARROW-16798
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Documentation, Website
>            Reporter: Ian Cook
>            Priority: Major
>         Attachments: screenshot-1.png
>
>
> For people browsing the Arrow docs site, it is not immediately clear how they can contribute changes/ additions to the docs pages they are reading. Is there a way that we can have each Sphinx docs page include some kind of info box or tooltip that links to the associated RST file in the repo?
> cc [~jorisvandenbossche] [~westonpace] [~lidavidm] 



--
This message was sent by Atlassian Jira
(v8.20.7#820007)