Summary: Any CAST User Community extension (i.e. a custom extension) requires documentation that is freely available on the internet. CAST highly recommends
creating the documentation within the GitHub repository you are using for the source code. This page describes the steps required to publish documentation in GitHub.
On this page:
|Table of Contents|
Authors of CAST User Community extensions
You need a GitHub account. If you already have an account you can use this, but if not you will need to create a new one - see https://github.com/join.
Membership of the CAST-Extend GitHub organization
You need to become a member of the CAST Extend organization. At the current time, please contact the GitHub user "CASTNDO" who will be able to add you to the organization. You will receive an email from GitHub (in the mailbox used for your GitHub account) containing a link which you need to click to confirm the membership.
Create a repository on GitHub
To create a new repository for your extension documentation:
- Access the CAST Extend organization on GitHub.
- Inside the organisation, create a new repository (as shown in the screenshot below):
- Fill in the required details for the repository:
- Include the extension title in the repository name
- Set the repository to public
- Tick the Initialize this repository with a README option
- Click the Create repository button
- GitHub repository (see Prerequisites and top-tips for creating a custom extension for more information about this) you are using to store the custom extension's source code, click the Wiki tab:
- Create a new page that will contain the extension documentation:
- Change the title of the page:
- Now enter the documentation, using the CAST-Extend template as inspiration: https://github.com/CAST-Extend/Template/wiki/Your-Extension-Documentation:
- When the documentation is complete, you can link directly to it in the Extension Description file.