KnowledgeBase Module Introduction

Overview

The KnowledgeBase module provides a simple knowledge base management system that allows teams to create, organize, and publish articles with categorization support. It features both administrative management and public access interfaces within your Laravel application.

Installation

The module is designed to be plug-and-play. Simply install it and you're ready to go.

With Module Manager

php mm:require-module knowledgebase

With Composer

composer require e2tmk/knowledgebase-module

Basic Usage

Once installed, the module provides:

• Article management through the Filament admin interface
• Classification/category system for organizing articles
• Public knowledge panel for end-users to browse articles
• Publication workflow with draft and published states

Optional Configuration

The only configuration you might need is for the RichEditor if you want to use S3 storage, custom directories, or privacy settings for file attachments.

RichEditor Configuration

If you need to configure file attachments for articles (for example, to use S3 storage), you can modify the RichEditor field in your form:

RichEditor::make('content')
    ->fileAttachmentsDisk('s3')
    ->fileAttachmentsDirectory('attachments')
    ->fileAttachmentsVisibility('private')

This is the only customization you would typically need to make in your forms.

Getting Started

1. Install the module
2. Access the admin panel and navigate to "Articles"
3. Create your first article
4. Organize articles using classifications
5. Publish articles to make them available in the public knowledge panel

That's it! The module handles everything else automatically.