Add documentation and release notes to a MARS app

This chapter describes the steps needed to add or change the documentation or release notes of a MARS app.

Add documentation

To add documentation to a MARS app, follow these steps:
  1. Make sure there is a subfolder in the root of PP_FILE_STORE with an identical name as the MARS app.
  2. Create a Markdown file readme.md and save it in the subfolder. For a cheatsheet about the Markdown format, refer to https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet.
  3. Add documentation content to the markdown file. Make sure that the documentation is clear and complete. See Documentation Guidelines for more information on documentation guidelines.
  4. Go to the MARS app in My Apps > Installed.
  5. Select Edit.
  6. Specify the documentation path in Documentation Path.

Edit the Markdown file

If the MARS App contains a Pagebuilder file, you can open and edit the Markdown file in PAGEBUILDER. To do so:
  1. Open a Pagebuilder file that is part of the MARS App.
  2. On the tab Cfapp on the left side.
  3. Select the readme.md file.
  4. Edit the readme.md file. You can see the result while editing.

Add release notes

To add release notes to a MARS app, follow these steps:
  1. Make sure there is a subfolder in the root of PP_FILE_STORE with an identical name as the MARS app.
  2. Create a Markdown file changelog.md and save it in the subfolder.
  3. Add content to the markdown file.
  4. Go to the MARS app in My Apps > Installed.
  5. Select Edit.
  6. Specify the path of the release notes in Documentation Path.