Uploaded image for project: 'Python Driver'
  1. Python Driver
  2. PYTHON-4047

Convert top level docs files to Markdown

XMLWordPrintableJSON

    • Type: Icon: Task Task
    • Resolution: Fixed
    • Priority: Icon: Unknown Unknown
    • 4.7
    • Affects Version/s: None
    • Component/s: None
    • None

      Context

      Markdown is easier to write and is interoperable with more tools. We can use pandoc to convert the files.

      brew install pandoc
pandoc -f rst -t markdown CONTRIBUTING.rst > CONTRIBUTING.md

      Definition of done

      Top level RST files are converted to MD.

      Pitfalls

      Ensure that no information is lost and that the docs render properly on GitHub.

            Assignee:
            steve.silvester@mongodb.com Steve Silvester
            Reporter:
            steve.silvester@mongodb.com Steve Silvester
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: