Skip to content

Knowledge Module Documentation

Welcome to the Knowledge module documentation. This guide covers installing, configuring, and using Knowledge-Centered Success practices on Drupal 11+.

KCS® is a service mark of the Consortium for Service Innovation.

Documentation Overview

This documentation is organized into several guides for different audiences:

For Sitebuilders

Installation Guide Complete instructions for installing the Knowledge module, including prerequisites, installation methods, post-installation setup, and troubleshooting.

  • System requirements
  • Composer installation
  • Manual installation
  • Post-installation configuration
  • Enabling optional features
  • Troubleshooting common issues

Configuration Guide Detailed configuration instructions for setting up knowledge types, fields, proficiency items, Process Alignment, the Content Standard Checklist, and permissions.

  • Global settings
  • Knowledge types setup
  • Field configuration
  • Proficiency system
  • Process Alignment
  • Content Standard Checklist
  • Permission management
  • Integration with other modules

User Guide Day-to-day usage instructions for content creators, knowledge contributors, and knowledge managers.

  • Creating knowledge links
  • Managing proficiency
  • Tracking Process Alignment
  • Recording Content Standard Checklist samples
  • Using reports
  • Best practices
  • Troubleshooting

For Developers

API Documentation Technical reference for developers extending or integrating with the Knowledge module.

  • Entity API reference
  • Services documentation
  • Hooks and alter functions
  • Plugin development
  • Field types
  • Database schema
  • Migration support
  • Testing
  • Code examples

Quick Start

New to the Knowledge module? Follow these steps:

  1. Install the module using Composer or manual installation
  2. Create a knowledge type defining your content relationships
  3. Add knowledge fields to your content types
  4. Configure permissions for your user roles
  5. Start creating knowledge links

What is the Knowledge Module?

The Knowledge module supports Knowledge-Centered Success on Drupal. Organizations can:

Core Features

  • Track Reuse: Connect support incidents (tickets, cases, issues) to knowledge articles
  • Proficiency Tracking: Monitor progression through Candidate, Contributor, and Publisher
  • Process Alignment Review: Sample whether linking practices were followed
  • Content Standard Checklist: Record six coaching checks on an article
  • Solve Loop: Reuse, Improve, Capture, Structure

Key Benefits

  • Improved Support: Quickly find and link relevant documentation to support cases
  • Knowledge Reuse: Track which articles are most useful and identify reuse opportunities
  • Gap Identification: Discover missing documentation through Process Alignment
  • Team Development: Track and develop proficiency
  • Content Standard: Maintain article standards through coaching samples
  • Data-Driven Decisions: Use reports to improve knowledge processes

Module Components

Main Module (knowledge)

Core Knowledge-Centered Success functionality:

  • Knowledge entity system
  • Knowledge types (bundles)
  • Statistics tracking
  • Views integration
  • Reporting

Submodules

Knowledge Field (required) Custom field types for proficiency tracking, automatically enabled as a dependency.

Knowledge LDAP (optional) LDAP integration for automatic leader/coach assignment based on directory attributes.

Getting Help

Documentation

Start with the appropriate guide above based on your role and needs.

Community Support

  • Project page: https://www.drupal.org/project/knowledge
  • Issue queue: https://www.drupal.org/project/issues/knowledge
  • Source code: http://cgit.drupalcode.org/knowledge

Support Resources

  1. Search the documentation: Use the guides above
  2. Check the issue queue: https://www.drupal.org/project/issues/knowledge
  3. Create an issue: Include steps to reproduce, expected vs. actual behavior, versions
  4. Drupal Answers: https://drupal.stackexchange.com (tag with knowledge)

Contributing

Contributions are welcome! Ways to contribute:

  • Report bugs: Create detailed issue reports
  • Request features: Describe your use case
  • Submit patches: Follow Drupal coding standards
  • Improve documentation: Submit updates or corrections
  • Write tests: Increase test coverage
  • Review patches: Help test and review contributions

See the API Documentation for technical details on extending the module.

Requirements

  • Drupal: 11.1+ or 12+
  • PHP: 8.3+
  • Required modules: Autocomplete ID, Charts, Content Moderation, Field, Moderation Note, Options, Search API, Text, Token

See the Installation Guide for complete requirements.

License

GPL-2.0+

Maintainer

  • Steve Ayers (bluegeek9): https://www.drupal.org/u/bluegeek9

Documentation Roadmap

Current Documentation (v1.x)

  • ✅ Installation Guide
  • ✅ Configuration Guide
  • ✅ User Guide
  • ✅ API Documentation

Planned Documentation

  • Screenshots and visual guides
  • Video tutorials
  • Migration guides from other knowledge systems
  • Advanced integration examples
  • Performance tuning guide
  • Security best practices
  • Multi-site configuration
  • Internationalization guide

Feedback

Have suggestions for improving this documentation?

  • Create an issue: https://www.drupal.org/project/issues/knowledge
  • Tag it with "Documentation"
  • Describe what's missing or unclear

Last Updated: 2026 Module Version: 1.x-dev