Your knowledge base settings enable you to configure your publishing workflow and customize the look and feel of your knowledge base.
Click any of the following links to skip ahead:
This article discusses functionality that is included in the Aha! Knowledge Advanced plan. Please contact us if you would like a live demo or want to try using it in your account.
Overview
Title
The Title section is where you can customize the title that will appear in the header of you knowledge base. This header will appear on every page.
Authentication
The settings in your Authentication settings determine who can access your knowledge base.
Public: Anyone with the URL can access your knowledge base.
Password: Visitors must enter a password to view your knowledge base.
SSO: Visitors can be authenticated to your knowledge base via single sign-on.
Publishing workflow
The settings in your Publishing workflow settings determine when changes you make to documents will appear on your published knowledge base website:
Publish as you write: Document edits are immediately visible in the knowledge base.
Publish after drafting: Draft changes can be published when you are ready.
If you have a custom role configured in your account, you may have an additional setting: Only users with a custom role may publish. Once you check the box next to the setting, only users with a custom publishing role will be able publish documents in your knowledge base.
There are two custom roles for publishing:
Publish knowledge bases: Only users with this custom role will be able to publish drafts to your knowledge base.
Publish knowledge bases with warning: Users with this custom role will be able to publish drafts to the knowledge base, but they will be given a warning confirmation when they do.
Search engine indexing
Depending on your public knowledge base's intended audience, you may or may not want your knowledge base to appear in search engine results when someone searches for your brand or product online. You can configure your knowledge base to allow search engines to index your knowledge base.
If you want your public knowledge base to be indexable by search engines, check the box next to All search engine indexing.
Allowing search engine indexing does not guarantee your knowledge base's appearance in search engine results. It simply allows search engines to index your knowledge base.
Navigation
Document navigation
Check the box next to Hide source documents if you want to display child documents as the top level of your knowledge base.
Source documents that do not have child documents will not be hidden when the Hide source documents setting is enabled.
Folder display
Choose how folders are displayed by default in the lift side navigation:
Collapse all: This option will collapse all folders, showing only the names of top-level folders.
Expand top level: This option will expand only the top level folders in your knowledge base.
Expand top two levels: This option will expand the top two levels of folders in your knowledge base.
Expand all: This option will display all folders expanding, displaying all folders and documents in your knowledge base.
Branding
Color
This color setting affects links and buttons in your knowledge base. Click the color icon to select a color or enter your own custom color using a hex code. You can also revert to the default Aha! Knowledge color if you need to.
Logo
Upload your company, product, or knowledge base logo here. It will be visible in the upper left corner of your knowledge base website. The optimal size and dimensions for your logo would be 480px by 300px, with a preferred aspect ratio of 1.6:1. Click Remove logo to remove your logo.
Favicon
Upload a favicon here. It must be .png, .gif, or .ico, and 16x16 pixels. Click Remove Favicon to remove it.
Custom domain / CNAME
By default, your knowledge base URL is in the format accountname.aha.io/kb/kbtitle. If you prefer to use a URL with your company's own domain to create a unified brand experience for your knowledge base visitors, click Add a custom domain. In the Add custom domain modal, enter your CNAME and select whether you want Aha! Knowledge to manage the SSL Certificate or manage it yourself. Click Save to save your changes.
Customize navigation
Choose what appears in your knowledge base navigation from here. Select from links or buttons, which will appear in your brand color.
To add a navigation item:
Click Add Navigation Item.
Enter a Title. This is the text that will appear in navigation.
Enter a URL. This is the destination of your navigation item.
Select a Style. You can choose a link or a button.
Choose a Position — left, center, or right.
Click Save.
Footer
Check the box next to Enable a footer to add a footer that displays at the bottom of every page of your knowledge base. Use the text editor to customize your footer content.
Custom URL path
When you publish a knowledge base, it is automatically assigned a random unique number ID as part of its URL path. Updating the Custom URL path replaces this random number ID — so you can simplify your knowledge base URL.
Enter your desired URL extension in the field provided. It must be comprised of lowercase letters and numbers. You cannot use spaces or special characters, but you can separate values by hyphens.
Documents
Your knowledge base's Documents settings enable you to add multiple root documents or folders to your knowledge base. Add a document or folder from any workspace. When you add a document, all nested child documents will be added as well.
Click Add documents to add a root document to your knowledge base.
Select the workspace where the document is located. The workspace's document hierarchy will appear.
Locate the document in the list or by using the search bar. Click the + next to the document.
Click Select documents.
If your knowledge base uses the Publish instantly workflow, you will see the root document added to your published knowledge base immediately. To reorder root documents in your knowledge base, drag and drop them into order in the table within your Documents settings.
Root documents will display their workspace of origin in the table within your settings. When a document is updated, it will follow the publishing workflow configured in each respective knowledge base it is included in.
When viewed within its workspace location, the top of the document will display the knowledge bases that include it.
A document used in multiple knowledge bases can only have one version.
Homepage
Your homepage creates a first impression of your knowledge base. Use it as an opportunity to guide your visitors towards the most valuable content, orient them to your documentation, and make your homepage a consistent extension of your brand.
Use these settings to design, structure, and enable your knowledge base homepage.
Featured sections
Organize your homepage into sections of featured pages, document folders, or external links. Use these settings to create, reorder, and populate your sections.
Click Add section to create your first section.
Section settings
Once you have created a section, use the section settings to design and populate it.
Section title: This title will display on your homepage.
-
Links: Populate your sections with links to folders, documents, or external pages.
Use this setting to create, reorder, and design links within your section.
Click Add link to create one. Each link has a Title, Link type, and optional Icon.
Number of columns: Sort links within a section into columns.
Link style: Links can appear Large or Small within a section. Large links can display link icons.
Icon: Choose an optional icon for your section.
Icons should be square and in file types .jpg or .png. Section icons should be 32x32px, and link icons should be 32x32px.
Homepage title
Customize the title of the homepage button in the left sidebar of your published knowledge base.
Headline
Enter an optional headline. This will display on your homepage above the search bar.
Header options
Choose what information you want to display in the homepage header. All of these are optional.
Show logo: Display your knowledge base logo (configured in Settings -> Branding -> Header logo) in your homepage header.
Show knowledge base title: Display your knowledge base title (configured in Settings -> Overview -> Title) in your homepage header.
Show search bar: Display the Aha! search bar on your homepage, so that your visitors can search the knowledge base.
Banner image
Select a banner image. In the next settings section, choose how you want the banner image to interact with any Header options you selected.
Banner images should be in landscape orientation and in file types .png or .jpg. They should have minimum dimensions of 1200x300px.
Banner style
Choose how your selected Header options should interact with your Banner image.
Covered: Header content will partially cover the bottom of your banner image.
Overlaid: Header content will appear on top of your banner image, with a gradient overlay to improve the text's visibility.
Enable homepage
Enable or disable your homepage.