All the documentation is published on https://docs.ukfast.co.uk/ -
If you would like to contribute a guide or amendment to an existing one, please fork the repository and submit a pull request.
To get started, please visit:
Please ensure pages and folders are easy to read and sensibly structured. Please keep the page urls lowercase and use hyphens instead of spaces. e.g.
- /desktop/fastdesk/getting-started/windows.html
When adding a new page these elements need to be considered to help site readability, usability, navigation and search results. Here's info on what each does, how to set them and some guidelines.
Sets the main heading for the page
To set
Add as first piece of content
# Transferring a Domain to UKFast
Add to top of file
======================
Domain Name Management
======================
The h1 tag is the title of the article and should give the reader a strong sense of what they are going to read. Should be around 20 - 70 characters but length is not forced.
By default - the page navigation and breadcrumb is populated from the Page Heading and often this is perfectly fine. But sometimes a longer page heading is better for the user, but will fill up the nav with long sentences or repeated words that are not needed inside a nav tree format. In these cases it's better to set the nav item specifically.
Example Custom Navigtation
.. toctree::
:maxdepth: 1
Transfering to UKFast <transferin>
Transfering from UKFast <transferout>
Changing Nameservers <changingnameservers>
DNS Propagation <dnspropagation>
This meta content determines how the page is displayed in search engine results, is crucial for the overall performance of the website from an SEO perspective and helps the user with history, bookmarks and the site search.
Appearance on Google
Use in the browser
The meta title is used in the search and displayed to the user in the site search results
In many cases the meta title can be the same as the Page Heading, but there are character length limitations we must adhere to so may require amending to be shorter.
Also give the content a description which can help search results, but page content is more important.
Please note spacing/indents are important so copy this template *
Meta content goes at the bottom of the file
```eval_rst
.. title:: Creating an eCloud Flex instance
.. meta::
:description: Detailed guidance on creating OpenStack instances on eCloud Flex
:keywords: openstack, ecloud flex, ukfast, nova, instance, virtual machine, vm
```
Meta content goes at the top of the page otherwise it will fail Travis checks
.. title:: Email | Email hosting
.. meta::
:description: Information regarding a wide range of email related issues
:keywords: ukfast, email, exim, postfix, mail, dovecot, blocklist, dkim, spf
(So same as .md files but not included within eval_rst)
Character Length Limitations for Meta
title- maximum of 42 characters, don't include "| UKFast Documentation" at the end as this is will be added via the template.description- maximum of 165 characters
Your pull request will fail the automated Travis checks without this meta content in the correct format.
Most content is simple markdown, but some features require ReStructuredText (rst) which uses quite different syntax than Markdown that need to be inside eval_rst blocks. Here are a few examples of how to add more types of content.
Where relevant please add screenshots to pages as image files (ideally .png). This is especially useful when describing how to complete a task in MyUKFast. If appropriate please blur out any sensitive information such as account names or IP addresses. Most image editors will allow you to add a blurred box over the image - this looks a lot neater than using a "black marker pen" style, like @simon.saffidine once tried to get away with.
Example image, the text preceeding becomes the Alt text
Tables need to be in RST format otherwise they won't display properly when published (it will look fine in Git, but will look horrible when published, trust me). There are free tools that will generate RST for you, http:https://www.tablesgenerator.com/text_tables# is good.
This is an example which works. Note the requirement to wrap in the eval_rst block.
```eval_rst =========== ======== ========================================================= Record Type Hostname Target =========== ======== ========================================================= CNAME portal 64cf9871a5b0ca045an96udtf9a63687c180f47df6.user.ddosx.com =========== ======== ========================================================= ```
For internal site links the easiest form to add them is like this:
:doc:`/ecloud/flex/general/openstackcli`
This will make a hyperlinks using the title of the page /ecloud/flex/general/openstackcli as the text.
If you wish to use text other than the heading for the section that you’re linking to, use the following format:
:doc:`Custom Text</ecloud/flex/general/openstackcli>`
For external links use:
[Go to the domain transfer in page in MyUKFast](https://my.ukfast.co.uk/domains/transfer-in.php).
Link Text Tip: Avoid using words like 'link' 'Click Here', 'Here' as the linking text. These are harder to pick out for the user and offer no idea of where the link will take them, without forcing them to reading the preceeding content which makes it harder. The text should give a good idea to the user where it will take them when reading it alone.
These must be done using RST, and the format is like this:
```eval_rst .. note:: Sectigo also provide an online EV click-through as an alternative. This is available on request. ```
See /domains/ssl/Extended_Validation_SSL as an example Page on Site | Mark Down
Adding this:
DDoSx\ :sup:`®`\
Renders like this: DDoSx®
Ensure you have docker and docker-compose installed.
git clone https://github.com/ukfast/docs.ukfast.co.uk.git ukfast_docs
cd ukfast_docs
docker-compose -f docker-compose.dev.yml up --buildOpen a browser to 'http:https://localhost:80'