Skip to main content

Knowledge Hub

Write, organize and share your company's policies, procedures and reference material, and keep the forms and templates your team uses in one place.

Overview​

The Knowledge Hub is your company's own library inside Readybuild. It holds two kinds of content:

  • Articles — pages you write in Readybuild, with headings, lists, tables, images, attached files and links to other articles
  • Files — standalone documents such as PDF forms and templates that staff can download

Everyone at your company can read published pages and download files. Only people with the Manage Knowledge Hub permission can create, edit, publish, unpublish or delete content.

Knowledge Hub content is only visible to your own staff. Nothing from it appears in the client portal.

Accessing the Knowledge Hub​

  1. Click Knowledge Hub in the main menu

The left side lists your pages and files, grouped in folders. Click a page to read it, or click a folder to see its pages and files. Click the arrow next to a folder to open or close it without leaving the page you're on. Home shows your top-level folders, the most recently updated pages and files, and anything that isn't in a folder.

Finding Content​

Type in the Search articles and files box at the top of the page. Search looks at:

  • Article titles and text
  • The names of files attached to articles
  • The names of files in the file library

Click a page title to open it. Click a file name to open it: images and PDFs open in a new tab, and other files download. Use the download button next to a file to save a copy.

note

Search updates automatically when content is added, edited, published or unpublished. A change can take up to a minute to appear in search results.

Managing Content​

Required Permission
Manage Knowledge Hub - You must have the Manage Knowledge Hub permission to access this setting.

The rest of this page covers tasks that need the Manage Knowledge Hub permission. Admins have it by default. See Roles to give it to other roles.

Draft and Published​

Every page has a status:

  • Draft — only people with Manage Knowledge Hub can see it. New pages always start as drafts.
  • Published — all staff can see it and find it in search

Drafts show a status label in lists and appear greyed out in the page list. Files don't have a status: everyone can see a file as soon as it's uploaded.

Creating a Page​

  1. Click New page. The new page goes in the folder you're viewing; to put it somewhere else, choose New page here from a folder's ⋯ menu.
  2. Type a title, then press Enter to start writing
  3. Click Save (or press Ctrl+S / ⌘S) to keep a draft, or Publish to make it visible to all staff

A new page is a draft that only editors can see, so you can leave it unfinished. A page saved without a title is called "Untitled".

The editor supports headings, bold and italic text, colors, bulleted and numbered lists, indentation, tables and links.

Adding Images​

  • Paste an image, or drag it into the editor, to upload it
  • Or click the Upload Image button in the toolbar

Images can be PNG, JPG or GIF files. Images inside an article are only visible to people who can see the article.

Attaching Files to an Article​

  1. Click the Attach a file (paperclip) button in the editor toolbar
  2. Choose the file

The file appears in the article as a link that readers can click to download.

Linking to Another Article​

  1. Click the Link to another page button in the editor toolbar
  2. Start typing the other article's title
  3. Select it and click Insert link

If the linked article is later deleted or unpublished, readers see the link text marked (unavailable) instead of a broken link.

Publishing or Unpublishing a Page​

  • Publish — click Publish at the top of the editor. Any unsaved changes are saved at the same time.
  • Unpublish — click ⋯ at the top of the editor and choose Unpublish. The page goes back to being a draft that only editors can see, and you can publish it again at any time.

Saving a published page updates what staff see right away.

Version History​

Every save that changes an article's title or content is kept as a version, along with who saved it and when.

  1. Open the page and click History (or ⋯ > Version history in the editor)
  2. Select a version on the left to preview it
  3. To go back to that version, click Restore this version

Restoring saves the old title and content as a new version. Earlier versions are never deleted, and the article's status stays the same.

If someone else saves the same article while you are editing it, your save is blocked with a message. Reload the article to see their changes, then make your edits again.

Deleting a Page​

  1. In the editor, click ⋯ and choose Delete, or use the ⋮ menu next to the page on the Home or folder view
  2. Confirm

Deleted articles disappear from the Knowledge Hub and search. Links to them show as unavailable.

Organizing with Folders​

Folders can be nested inside other folders.

  • Create a folder — hover over Pages in the left panel and click +, or choose New subfolder from a folder's ⋯ menu (hover over the folder to see it)
  • Rename or move a folder — choose Rename or move from the folder's ⋯ menu, change the name or the Inside folder, then click Save
  • Give a folder an icon and color — when creating a folder or choosing Rename or move, pick an Icon and a Color. Default is the plain folder icon.
  • Delete a folder — choose Delete from the folder's ⋯ menu. Its subfolders, pages and files move up one level; nothing inside is deleted.
  • Move a page — in the editor, click ⋯ and choose Move to folder
  • Move a file — choose Move to folder from the file's ⋮ menu

Staff only see folders that contain content they can open.

Uploading Files to the Library​

The quickest way is to drag files from your computer onto a folder's page. They upload into that folder, and all staff can see them right away.

Or use the upload button:

  1. Open the folder you want (or Home), then click Upload files at the top
  2. Click Choose files and select one or more files
  3. Optionally give each file a Name (for example "Certificate of Insurance"). Leave it blank to use the filename.
  4. Click Upload

To rename, move or delete a file later, use the ⋮ menu next to it (in the page list, hover over the file and click ⋯). A renamed file still downloads with its original file type.