Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
86 lines (51 sloc) 3.26 KB
title description services author toc_rootlink toc_sub1 toc_sub2 toc_sub3 toc_sub4 toc_title toc_fullpath toc_mdlink
How to contribute to the UKCloud Knowledge Centre | UKCloud Ltd
Describes how to submit changes to articles in the UKCloud Knowledge Centre and how to create new articles
other
Sue Highmoor
How To
Contribute to the UKCloud Knowledge Centre
How To/other-how-contribute-knowledge.md
other-how-contribute-knowledge.md

How to contribute to the UKCloud Knowledge Centre

Overview

Content for the UKCloud Knowledge Center is stored in a GitHub repository, which means that anyone with a GitHub account can submit changes to articles and even add new articles.

This article explains how to submit changes to UKCloud Knowledge Centre articles.

[!IMPORTANT] Before making any changes, make sure you're familiar with our guidelines for contributing to Knowledge Centre articles.

Intended audience

To submit changes or new articles you must have a GitHub account.

Submitting minor changes to an existing article

  1. Go to the UKCloud Knowledge Center at:

    http://docs.ukcloud.com

  2. Find the article that you want to edit.

  3. Click Improve this Doc to open the article in GitHub.

    Improve this Doc link

  4. If necessary, log in to GitHub.

  5. Click the Edit the file (pencil) icon.

    Edit this file icon in GitHub

  6. Edit the article as required.

  7. When you're done, at the bottom of the page, enter a short descriptive name for your change and, optionally, a longer description to provide more detail.

  8. Click Propose file change.

    Propose file change

  9. Review the changes you've made.

  10. Click Create pull request.

  11. On the Write tab, provide more details about the change you've made, if necessary, then click Create pull request.

    Create pull request

    [!NOTE] You must create the Pull Request to submit your changes.

  12. The Pull Request is submitted to UKCloud to review and merge into the master branch if appropriate. We may contact you to discuss the details of your changes if required.

Submitting larger changes across multiple articles or creating new articles

If you're familiar with working in GitHub and want to submit changes to multiple articles, or even create a new article, you may find it easier to fork the repository and work on your changes there before creating your Pull Request.

For a template to get you started with a new article, see UKCloud Knowledge Centre article template.

Suggesting significant changes

If you want to suggest significant changes to the Knowledge Centre, contact products@ukcloud.com to discuss your ideas.

Related videos

Feedback

If you find an issue with this article, click Improve this Doc to suggest a change. If you have an idea for how we could improve any of our services, visit UKCloud Ideas. Alternatively, you can contact us at products@ukcloud.com.