If you'd like to contribute to docs.ukfast then please write / produce your content in line with this guide. Note your content may be subject to modification before or after publication.
Please use the following terms correctly and consistently:
| Correct term | Examples of incorrect terms | Notes |
|---|---|---|
| MyUKFast | MyUKFast portal, MyUKFast client area, the client portal | include an embedded link to https://my.ukfast.co.uk at least once on page |
| server | device, machine | |
| virtual machine | virtual server | if abbreviating to "VM" then put "virtual machine (VM)" first time on page |
| eCloud | ecloud, Ecloud | |
| FASTdesk | Fastdesk, DaaS, Daas, | |
| FASTdrive | Fastdrive | |
| FASTcloudbackup | Fastcloudbackup, Fast cloudbackup | |
| Webcelerator | Web celerator, Web acceleration, Web Accelerator | abbreviation to "Webcel" is ok |
The top-level categories are as set out below. Please do not create a new top-level category without checking first.
| Category | Content included |
|---|---|
| Cloud | UKFast's cloud products, cloud guidance |
| Desktop and office solutions | UKFast's products such as FASTdesk, FASTdrive |
| Security | UKFast security products, general security guidance |
| Domains and DNS Management | UKFast products for managing domains and DNS, plus general guidance |
| Backups and Disaster Recovery | UKFast products for backup and DR, plus general guidance |
| Networking | Networking guidance and principles, including load balancing etc. |
| Monitoring and usage management | UKFast monitoring products, plus general guidance |
| Operating systems | Guidance relating to Linux and Windows, various "how-to's" |
| Other technologies | Guidance relating to non-UKFast technologies and software such as Wordpress, MySQL, Magento etc. |
You're welcome to create a new subcategory, for example in relation to a UKFast product or service, or a third party technology where we have some useful guidance or best practise to share. Where appropriate, please try to structure categories as follows:
- Include a short introduction (even if just a single sentence) in the catgory
index.rstfile, so readers don't have to click any further to find out what it's about. - Then have a "General Information" page.
- Next, a "Getting Started" guide - this is especially important if talking about a product, whether from UKFast or a third party.
- You'll probably need a few product or topic-specific pages.
- Always include a "Troubleshooting" page. What are the common problems people run into, and how can they be solved?
- Consider a "Technical information" page if it's likely readers/customers may need detailed technical knowledge of the product
- Link to ukfast.co.uk, other docs.ukfast pages, and external websites as necessary. Certainly try not to replicate content already covered on other docs.ukfast pages, just link to the relevant page.
The FASTcloudbackup category is a good example of how to structure a category.