Publishing this Documentation

This documentation is maintained in Documentation Monster which provides the project and topic management for the documentation.

Using Git for Documentation Content Collaboration

Documentation Monster uses Git for synchronization of the documentation content. DM uses individual Markdown files for topics, plus a central JSON file to hold the project topic metadata about each topic.

When making changes it's recommended you frequently check in your changes and push them to GitHub which can then be picked up other users to retrieve the latest documentation.

Publishing Documentation For Web Access

The documentation can be published in a variety of ways:

• FTP Site
• GitHub Pages (into a /docs folder via file copy then pushing)

Publishing to Ftp

FTP publishing is the easiest but it requires an FTP server somewhere to publish to. Once you have a server set up the process is:

• Generate the Web Site (into /wwwroot folder)
• Publish - Ftp Site
• Specify the Ftp site and folder to publish to

Publishing to GitHub Pages

To publish to GitHub Pages involves (assume repo is ReserveFundManagerDocs):

• Generate the Web Site (into /wwwroot folder)
• Make sure use a Relative Base Url of /ReserveFundManagerDocs/
• Publish - Copy to Folder
• Select <yourRepo>/docs as the output folder (create folder if needed)
• Commit changes and Push to GitHub
• Access the site with https://bplander.github.io/ReserveFundManagerDocs

For the GitHub repo in question ReserveFundManagerDocs the entire Documentation Monster project is the repository and it picks up the /docs folder content for GitHub pages.