Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-18393

[Docs][R] Include warning when viewing old docs (redirecting to stable docs)

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • Documentation, R
    • None

    Description

      Now we have versioned docs, we also have the old versions of the developers docs (eg https://arrow.apache.org/docs/9.0/developers/guide/communication.html). Those might be outdated (eg regarding communication channels, build instructions, etc), and typically when contributing / developing with the latest arrow, one should always check the latest dev version of the contributing docs.

      We could add a warning box pointing this out and linking to the dev docs.

      For example similarly how some projects warn about viewing old docs in general and point to the stable docs (eg https://mne.tools/1.1/index.html or https://scikit-learn.org/1.0/user_guide.html). In this case we could have a custom box when at a page in /developers to point to the dev docs instead of stable docs

      Attachments

        Issue Links

          Activity

            People

              thisisnic Nicola Crane
              jorisvandenbossche Joris Van den Bossche
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: