Uploaded image for project: 'CarbonData'
  1. CarbonData
  2. CARBONDATA-4236

Documentation correctness and link issues in https://github.com/apache/carbondata/blob/master/docs/

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 2.2.0
    • 2.3.0
    • docs
    • None
    • docs with content and examples verified on Spark 2.4.5 and Spark 3.1.1 compatible carbon.

    Description

      In the documentation linkĀ https://github.com/apache/carbondata/blob/master/docs/

      Issue 1 :-
      In link -> https://github.com/apache/carbondata/blob/master/docs/configuration-parameters.md the "See detail" links does not open the target "http://spark.apache.org/docs/latest/rdd-programming-guide.html#rdd-persistence"
      In link --> https://github.com/apache/carbondata/blob/master/docs/documentation.md the link "Apache CarbonData wiki" when clicked tries to open link "https://cwiki.apache.org/confluence/display/CARBONDATA/CarbonData+Home" the target page cant be opened. Similarly the other links in the "External Resources" section cant be opened due to the same error.
      In link https://github.com/apache/carbondata/blob/master/docs/faq.md#what-are-bad-records the link "https://thrift.apache.org/docs/install" when clicked does not open the target page.
      In link https://github.com/apache/carbondata/blob/master/docs/quick-start-guide.md when the "Spark website" link is clicked https://spark.apache.org/downloads.html page is not opened. Also in same page when the "Apache Spark Documentation" link is clicked the "http://spark.apache.org/docs/latest/" page is not opened.
      In the link https://github.com/apache/carbondata/blob/master/docs/release-guide.md "Product Release Policy link" , "release signing guidelines" , "Apache Nexus repository" and "repository.apache.org" when clicked the target pages are not opening.

      Issue 2:-
      In link --> https://github.com/apache/carbondata/blob/master/docs/configuration-parameters.md the "To configure Ranges-based Compaction" to be changed to "To configure Range-based Compaction"

      Issue 3:-
      In link --> https://github.com/apache/carbondata/blob/master/docs/configuration-parameters.md the "Making this true degrade the LOAD performance" to be changed to "Making this true degrades the LOAD performance"

      Issue 4 :-
      In link --> https://github.com/apache/carbondata/blob/master/docs/configuration-parameters.md the "user an either set to true" to be changed to "user can either set to true"

      Attachments

        Activity

          People

            Unassigned Unassigned
            chetdb Chetan Bhat
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: