Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

As technology changes, so must the information that supports it. The Knowledge Base (KB) is a dynamic resource designed to support and be curated by our UConn community. We welcome commentscollection of information that offers technical support to the UConn community.  ITS faculty and staff can contribute by creating and editing articles within Confluence, an online workspace. Comments, additions, and revisions are welcome.

ITS welcomes contributions from our UConn community. To edit and add to the KB, you need an account on Confluence, the platform for the KB. Contact ITKB@uconn.edu to request an account. 

Getting Started

Once you have been given access to the KB, the next step is to log in. 

When you are not logged into Confluence, you will see the theme that we applied to our space. This theme improves the usability and the appearance of the KB. To make updates to the content displayed, you need to log into Confluence, the application ITS uses for the KB.

...

Go to the Information Technology Knowledge Base homepage.

...

To request a Confluence account, contact ITKB@uconn.edu.

Panel
panelIconId1f510
panelIcon:closed_lock_with_key:
panelIconText🔐
bgColor#E3FCEF

If you have a Confluence account, log in with your UConn email address and password at uconn.atlassian.net.

Log into Confluence for editing access in the Knowledge Base

  1. Go to kb.uconn.edu.

  2. Click Log In from the upper righthand corner of the screen.

  3. Enter your UConn email address and click Next.

...

  1. Once redirected, click Log in with single sign-on.

  2. Enter your NetID and password. Student employees should enter the credentials for their student work account (abc12345work and the password set up for the work account).

You are now on the homepage for the UConn Knowledge Base. The Knowledge Base is a collection of Confluence spaces, which divide the content into categories. Knowledge Base contributors have access to and can edit content in these spaces.

After you log in, you may be taken to the main page for Confluence instead of your Space. If this happens,

  1. Click Spaces in the upper navigation.

  2. Select View all spaces if you do not see yours listed.

  3. Enter [your Space name] in the search/filter field.

  4. You are now on the homepage for your Space. Navigate the space using either the page tree or search box. 

Editing Articles

Editors are invited to also edit pre-existing articles where they see fit. If you are on a page and can improve the information provided, please feel free to edit the page. 

  1. Log in to the Knowledge Base.

  2. Navigate to the page you wish to revise. Click on the edit pencil icon in the upper-right navigation.

  3. Enter your changes using the text editor tools.

  4. Click the blue Publish button in the bottom right corner of the screen. Your changes will then be live.

  5. To view your page within our applied theme, click Refined in the top-center of the window. Choose to View in Refined.

  6. In the new browser tab, you will see the live page as it appears to the public.

  7. Close the tab to return to the editor view.

Creating New Articles While in the Theme

Editors are invited to create articles where they see fit. With your intended topic in mind, navigate to the KB page that you would like to nest your new article under. This begins the Parent-Child page relationship. A page that is nested under another is considered a "Child" page, while the page that holds the Child pages is considered the "Parent" page.

  1. Log in to the KB.

  2. Go to the section where you wish to add an article. Click the ellipsis and select Create new page in Confluence.

    create new pageImage Removed
  3. You will have a blank page for your article and can add and publish your content.

Tip

We recommend using a how-to article template.

Creating New Articles in Confluence

There are two ways to create a new page using the Parent page:

  1. Navigate to the Parent page in the page tree.

    1. Click on the blue Create button at the center-top of the window.

  2. Find your Parent page in the page hierarchy.

    1. Hover your cursor over the list item and click on the + (plus) button.

      plus buttonImage Removed

Using a Template for New Articles

...

Info

On most blank pages, your template options will automatically display. If you have do not see the panel, click the ellipsis () and select Templates & import doc.

  1. Search for and select the How-to article template.

    how to articleImage Removed
  2. Begin documenting your topic. Click Publish when you are finished.

Reach out to ITKB@uconn.edu with any questions.

Filter by label (Content by label)
showLabelsfalse
max10
showSpacefalse
cqllabel in ( "kb" , "ITKB" , "knowledge_base" , "knowledgebase" ) and space = "IKB" and type = "page"

...

have successfully logged into the Knowledge Base and can access or edit the available content.

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.

...

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.

...

Panel
panelIconId270f
panelIcon:pencil2:
panelIconText✏️
bgColor#FFFAE6

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.

...

Keyboard Shortcuts

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

Links to Knowledge Base Guides

Panel
panelIconIdatlassian-question_mark
panelIcon:question_mark:
panelIconText:question_mark:
bgColor#DEEBFF

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