Managing Documentation in Freshdesk

Brief overview: source for the documentation is in markdown files in the documentation repository. "Empty" articles are created and organized in categories in Freshdesk. Each article has a numeric identifier. The freshpush.ini file maps the markdown documents in the repository to the appropriate numeric identifier so that the content gets pushed into that article in Freshdesk.

For more details, see this page.

Relevant links:

• Documentation repository: https://github.com/OSGConnect/connectbook
• Freshdesk solutions: https://support.opensciencegrid.org/a/solutions/
• Rendered Docs: https://support.opensciencegrid.org/support/home
• Style guide: https://osg-htc.org/technology/documentation/style-guide/

Adding a Document

Original documentation here

Reorganizing Content

Manage folders and article hierarchy in Freshdesk.

You have to update organization in markdown files in connectbook repository manually; however, we like to do this to make it easier to find the appropriate markdown file to make changes.

Editing a Document

Original Documentation here

Archiving or Removing a Document

• Clone the documentation repository if you haven't already. git clone --recursive https://github.com/OSGConnect/connectbook.git
• Move the file to the archive folder. git mv document.md archive git commit -a -m "archiving document"
• Remove that document's entry from update/freshpush.ini
• In Freshdesk, delete the corresponding article.