markdown-publishing-guide

Documents

• Markdown Publishing Guide v1.0.3
  • Introduction
  • Motivation
  • Scope
  • Existing Documents and Troubleshooting
  • Preparing for Development
  • Setting up a New Project
    • Creating a GitHub Repo with Initial Content
      • Create a New Repo in the GitHub Web Interface
      • Create docs/user-guide.md with initial content
      • Add project info and links to README.md
      • Create Document list for GitHub in docs/README.md
      • Create a Table of Contents for ReadTheDocs in docs/index.rst
      • Create docs/conf.py
      • Create docs/requirements.txt
    • Setup ReadTheDocs project
      • Import Project
  • Publish v0.0.0 Project Release
    • Add CHANGELOG.md with v0.0.0 description
    • Create release v0.0.0
    • Create branch “latest-release”
    • Activate Version on ReadTheDocs
    • Setup ReadTheDocs default version
    • Test versions on ReadTheDocs
  • Develop the Next Version
    • Update version on master to indicate version in development
    • Improve the content
  • Release the Next Version
    • Set the version number
    • Edit CHANGELOG.md to include vX.Y.Z description
    • Create GitHub release
    • Merge release tag to ‘latest-release’ branch.