PLEASE READ FIRST: Guidelines for documentation contribution

This category is a list of requests for community contributed documentation articles.
Basically, asking for your help in the creation of specific documentation :pray:

To ‘claim’ a topic to take on, just post a comment against the topic noting your intentions to contribute.
Or, if you have your own suggested article just private message me to let me know (@Adam.Wilson ).

Some loose guidelines for documentation:

Screenshots:

  • Full-width admin screenshots to be taken with a browser width of around 1400px
  • Crop out the top ribbon (with your Partner logo, etc) unless the article is specifically referencing elements in that section.
  • Only use screenshots were necessary. Unnecessary screenshots/images will only cause headaches when admin UI changes and these need to be updated. Extra images will also make site loading slower.

Videos:

  • Ideally, written text documentation is preferred. Consistent videos can then be created from the written documentation as needed.

Text:

  • Feel free to supply the text in any digital format you wish (Google Doc, Word file, Email… but not fax :wink:)
  • In English please (and preferably UK spelling but I won’t be picky)

Syntax:

  • Always write the full name of “Treepl CMS” with capitals, ie: not “treepl”
  • When referring to general Treepl CMS concepts/terms I try and use title case. eg: Partners, Secure Zones, Partner Portal.
  • When referring to specific sections or actual CMS items I tend to use single quotes around the title case term. eg: ‘CRM’ > ‘Contacts’, the ‘System Properties’ section, or, the ‘SEO’ tab…
  • When referring to buttons or actionable elements I try to use double quotes. eg: “Add New Item”, “Save”, “Delete :grimacing:”…

Links:

  • Try to minimise internal documentation links if possible (as these could prove difficult to manage as the docs evolve). Instead, we try and utilise the ‘Related Articles’ section at the end of the document. Same page anchor links are ok though.
  • Try to minimise external links within the article. Instead, we try to utilise the ‘External Resources’ section at the end of the document to avoid messy and distracting links throughout.

Submission:

  • After ‘claiming’ a topic as a contributor I’ll private message you with my email address.
1 Like

In English please (and preferably UK spelling but I won’t be picky)

(long live the Commonwealth :stuck_out_tongue_winking_eye:)

1 Like