how-to-guides

No menu items for this category

Overview of Knowledge Center

As organizations increasingly rely on OpenMetadata for discovery, collaboration, data quality, observability, and governance, there is a need to house long-form articles right within OpenMetadata to describe architecture, showcase usage tutorials, and document best practices in data management. Instead of turning to tools like Google Docs or Confluence to document these extensive details, data teams can create articles in OpenMetadata's Knowledge Center to share crucial information with the team.

Knowledge Center helps to centralize tribal knowledge and enhance data documentation in your organization. The Knowledge Center supports the creation of in-depth, long-form knowledge articles. The innovative new editor facilitates rich content creation, embedding images and other media to elucidate complex details. OpenMetadata's knowledge center fosters seamless connection between documentation and data assets by allowing users to tag teams and data assets as references. Knowledge Articles come equipped with comments, version history, and all the other features that are an integral part of OpenMetadata.

Knowledge Center

Knowledge Center

To create a knowledge article, navigate to the Knowledge Center and click on Add Article.

Knowledge Center

Knowledge Center

Type / to select text styles like Headers, Text, Bulleted List, Numbered List, Code Block, Data Assets, Quote, Images, Divider, and @ Mentions.

Knowledge Center

Knowledge Center

Knowledge articles can be owned by Users as well as Teams.

A Team or a User can be the Owner

A Team or a User can be the Owner

You can arrange your articles hierarchically by nesting the articles. From the left menu in the Knowledge Center, click on the + next to an article to create a nested article.

Nested Articles

Nested Articles

Knowledge articles can be associated with the concerned data assets, so that information about the data assets is readily available. Click on + in the right hand menu for Data Assets to search and add the related data assets for an article.

Associate Data Assets

Associate Data Assets

Associated Data Assets

Associated Data Assets

In the knowledge article, you can also type # and start typing to be able to select the relevant data asset to tag it.

Associate Data Assets

Associate Data Assets

You can also use the / command, scroll down, and select the option Link Data Asset.

Associate Data Assets

Associate Data Assets

Use the / command, scroll down, and select the option Mention.

Tag Teams and Users

Tag Teams and Users

Or you can simply type @ and start typing to be able to mention the concerned person or team.

Tag Teams and Users

Tag Teams and Users

You can categorize the articles in your Knowledge Center by tagging the articles. The option to tag is available on the right hand panel of the article.

Tag the Article

Tag the Article

Similarly, you can add glossary terms to the knowledge article by selecting the required glossary terms from the right hand panel of the article.

Associate with Glossary Terms

Associate with Glossary Terms

While creating or updating articles, or even when deleting existing articles, you can communicate with your fellow team members using comments for that article.

Click on the chat icon to add comments.

Comment on an Article

Comment on an Article

You can tag your team in the comments and also add emojis.

Comment on an Article

Comment on an Article

If you already have a comprehensive knowledge article in an external source, and you want to reference those links within the knowledge center, then such links can be added as Quicklinks. From the Knowledge Center, click on the Add button to add a quicklink.

Add a Quicklink

Add a Quicklink

Enter the details and save the quicklink

Quicklink Details

Quicklink Details

You can also add tags and associate glossary terms with the quicklinks.

Quicklink Details

Quicklink Details

Users can search for knowledge articles by Owners and Tags.

Associated Data Assets

Associated Data Assets

Users can click on the Star icon to bookmark the articles while in the knowledge article page.

Star to Bookmark the Article

Star to Bookmark the Article

When in the article listing page, users can click on the Bookmark icon.

Bookmark the Article

Bookmark the Article

You can view all the bookmarked articles in the right hand side.

Bookmarked Article

Bookmarked Article

Users can rate the knowledge articles by upvoting or downvoting them.

Rate the Article

Rate the Article

When viewing the list of knowledge articles, you can get a quick preview of the selected article. The preview is displayed on the right hand side.

OpenMetadata displays the version history of the knowledge articles. Click on the version history icon to view the details.

Version History of the Article

Version History of the Article

Click on the icon on the top right of the knowledge article or quicklinks page and select the option Delete.

Delete an Article

Delete an Article

All the articles that are owned by you or your team are displayed in the Knowledge Center widget on your 'My Data' page.

Knowledge Center Widget

Knowledge Center Widget

With Knowledge Center, critical knowledge and documentation are readily available where users need them, making OpenMetadata a comprehensive hub for all things data.