Uploaded image for project: 'CDAP'
  1. CDAP
  2. CDAP-683

Change all README files from markdown to rst format

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.1.0
    • Component/s: Docs
    • Labels:
    • Rank:
      1|hzyhkn:

      Description

      Here are proposed changes to be made to the documentation for release 2.6.0:

      1. Change all README.md files to README.rst. This will:

      • make it easier to incorporate a README into the Sphinx build system; it won't need translating;
      • when the build system is automated, pandoc will not be required; and
      • people only need to use one format (rst) when writing docs.

      2. Move "Troubleshooting" out of the "Developers’ Manual" and into the "Administration Manual", "Operations" section. completed

      3. Change the order of the manuals from the current one to: completed

      • Developers’ Manual
      • Administration Manual
      • Examples, Guides, and Tutorials
      • Reference Manual
      • Release Notes
      • Glossary
      • FAQ

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                John John Jackson
                Reporter:
                John John Jackson
              • Votes:
                0 Vote for this issue
                Watchers:
                1 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: