The documentation for this years Hackathon must be provided as a readme in Markdown format as part of your submission.
You can find a very good reference to Github flavoured markdown reference in this cheatsheet. If you want something a bit more WYSIWYG for editing then could use StackEdit which provides a more user friendly interface for generating the Markdown code. Those of you who are VS Code fans can edit/preview directly in that interface too.
Examples of things to include are the following.
Category: Hackathon Category
What is the purpose of your module? What problem does it solve and how does it do that?
Does your module rely on other Sitecore modules or frameworks?
- List any dependencies
- Or other modules that must be installed
- Or services that must be enabled/configured
Provide detailed instructions on how to install the module, and include screenshots where necessary.
- Use the Sitecore Installation wizard to install the package
How do you configure your module once it is installed? Are there items that need to be updated with settings, or maybe config files need to have keys updated?
Remember you are using Markdown, you can provide code samples too:
<?xml version="1.0"?> <!-- Purpose: Configuration settings for my hackathon module --> <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/"> <sitecore> <settings> <setting name="MyModule.Setting" value="Hackathon" /> </settings> </sitecore> </configuration>
Provide documentation about your module, how do the users use your module, where are things located, what do icons mean, are there any secret shortcuts etc.
Please include screenshots where necessary. You can add images to the
./images folder and then link to them from your documentation:
You can embed images of different formats too:
And you can embed external images too:
Please provide a video highlighing your Hackathon module submission and provide a link to the video. Either a direct link to the video, upload it to this documentation folder or maybe upload it to Youtube...