Uploaded image for project: 'Spark'
  1. Spark
  2. SPARK-12370

Documentation should link to examples from its own release version

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.1, 2.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      When documentation is built is should reference examples from the same build. There are times when the docs have links that point to files in the github head which may not be valid on the current release.

      As an example the spark streaming page for 1.5.2 (currently at http://spark.apache.org/docs/latest/streaming-programming-guide.html) links to the stateful network word count example (at https://github.com/apache/spark/blob/master/examples/src/main/scala/org/apache/spark/examples/streaming/StatefulNetworkWordCount.scala). That example file utilizes a number of 1.6 features that are not available in 1.5.2.

        Attachments

          Activity

            People

            • Assignee:
              as2 Jagadeesan A S
              Reporter:
              brianlondon Brian London
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: