Contributing to the Knowledge Base

The UConn Knowledge Base (kb.uconn.edu) provides information about how to use the systems, services, and software available at UConn. For the UConn KB, we use Confluence, a content creation and collaboration platform.

Faculty and staff are welcome to contribute and edit content. To be a contributor, request access to Confluence and the KB by sending a message to ITKB@uconn.edu.

How the KB is made

The UConn Knowledge Base is a collection of Confluence spaces. Spaces are a designated workspace that can be individually managed. We have spaces for major themes, such as IT, finances, and student systems.

We pull these separate spaces together with a theme. The theme creates a searchable public portal and gives us the domain name kb.uconn.edu. Most visitors view the KB content through this public view.

Content is edited and added, however, in Confluence. This article provides a brief introduction on how to get started.

Log into Confluence

Go to kb.uconn.edu.
Click Log In from the upper righthand corner of the screen.
Enter your UConn email address and click Next.
Click Log in with single sign-on or Continue with Atlassian account.
Enter your NetID credentials. Student employees should enter the credentials for their student work account (abc12345work and the password set up for the work account). Log in with Duo, if prompted.

You have successfully logged into the Knowledge Base and can edit and add content.

Edit an Article

If you are visiting an article in the theme (URL starts with kb.uconn.edu/…), click the pen icon in the upper right-hand side of the screen. You will be taken to Confluence and be able to edit the content of the article. Click Update when you’re done to publish the changes.

If you are visiting the article in Confluence (URL starts with uconn.atlassian.net/wiki/…), you also click pen icon in the upper right-hand corner of the screen. Click Update to publish any changes.

When you are actively editing an article, the editing toolbar will appear along the top of the screen. It will provide you with options, such as text styles, bullets, numbered lists, and alignment, that will help you organize and format the page.

Create a New Article

To create a new support article, use the left sidebar menu to find an appropriate location for page. You should group it under an existing article that outlines general support, for example “Network” or “Email.”

Hover over the appropriate host article in the sidebar menu and click the + button to create a child page.

Click to add an article under the appropriate category

If you’re creating an article that includes instructions, you can use a how-to article template:

Your template options are displayed automatically on the right sidebar menu, or you can click the ellipses (…) in the upper righthand corner of your browser window and click Templates & import doc.

Use the how-to-template as a guide for structuring your support article.

To edit an existing article, open it click the pencil icon in the upper righthand corner of your browser window.

When you’re finished with the article, click Publish from the bottom righthand corner of the window. Your changes are live. To view the page as it appears for public viewers, click Refined from the tool bar and click View in Refined.

Article Labels

Article labels enable automatic grouping of support articles with related content. After publishing your article, add 2-3 article labels that signify the article’s general topic.

Effective article labels: names of websites, software, operating systems, services, storage solutions, applications
Non-effective article labels: exact models, adjectives describing the type of article, phrases more than three words long

For example, this page’s article labels may be, “confluence” and “knowledge base” NOT “support article” or “informational.” For more examples and guidance on creating article labels, visit: Labeling Guide: UConn Knowledge Base.

Remove the “kb-article-how-to” from the article labels. It automatically applies to articles that use the how-to template, but is unnecessary and will group the article with unrelated content if it is not removed.

Remove this label after publishing your article.

Keyboard Shortcuts

You can use Confluence keyboard shortcuts to more efficiently write and edit articles in the Knowledge Base.

Links to Knowledge Base Guides

For questions or additional support on contributing to the IT Knowledge Base, contact ITKB@uconn.edu.