{"id":13654228,"url":"https://github.com/alexbevi/redmine_knowledgebase","last_synced_at":"2025-04-07T01:09:37.953Z","repository":{"id":809092,"uuid":"515826","full_name":"alexbevi/redmine_knowledgebase","owner":"alexbevi","description":"A knowledgebase plugin for Redmine","archived":false,"fork":false,"pushed_at":"2024-10-05T11:10:20.000Z","size":1199,"stargazers_count":458,"open_issues_count":32,"forks_count":197,"subscribers_count":71,"default_branch":"master","last_synced_at":"2025-03-31T00:10:03.192Z","etag":null,"topics":["redmine","redmine-plugin","ruby-on-rails"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"mikeal/node.couchapp.js","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alexbevi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null}},"created_at":"2010-02-12T22:11:19.000Z","updated_at":"2025-03-23T22:34:11.000Z","dependencies_parsed_at":"2025-01-03T23:15:31.941Z","dependency_job_id":null,"html_url":"https://github.com/alexbevi/redmine_knowledgebase","commit_stats":{"total_commits":661,"total_committers":80,"mean_commits":8.2625,"dds":"0.42208774583963693","last_synced_commit":"f90393ed938cb4cfab058e22cb556b12e375457f"},"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexbevi%2Fredmine_knowledgebase","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexbevi%2Fredmine_knowledgebase/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexbevi%2Fredmine_knowledgebase/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexbevi%2Fredmine_knowledgebase/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexbevi","download_url":"https://codeload.github.com/alexbevi/redmine_knowledgebase/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247574086,"owners_count":20960496,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["redmine","redmine-plugin","ruby-on-rails"],"created_at":"2024-08-02T02:01:25.282Z","updated_at":"2025-04-07T01:09:37.931Z","avatar_url":"https://github.com/alexbevi.png","language":"Ruby","funding_links":[],"categories":["Plugins"],"sub_categories":["Inactive Plugins"],"readme":"# MAINTAINER NEEDED\n\nThe Redmine Knowledgebase is still receiving pull requests and issues, but does not have an active maintainer. I (@alexbevi) stepped away a number of years ago, and Robert (@robspearman) stepped in and took over. It's been a couple years now and Robert's availability is diminished so we're on the lookout for a new steward for the project. If you're interested shoot me an email at alex@alexbevi.com.\n\n# Redmine Knowledgebase Plugin\n\n![](screenshots/tiled-articles-201801.jpg \"Screenshot of tiled view option.\")\n\n## Overview\n\nThis plugin adds professional knowledgebase functionality to the [Redmine](http://www.redmine.org/) project management application.\n\n## Recent Changes\n\n* Redmine 4.1.x support (thanks @Reshetov!)\n* No longer conflicts with Redmine CRM plugin.\n* Tiled visual indexes are now supported using thumbnails.\n* Articles are better formatted to work with more themes.\n* Tag logic is improved and critical tags can be defined easily.\n* Email notifications are better formatted.\n* Bug fixes.\n\n## Warnings\n\nThe latest version of this plugin is for Redmine 4.1.x. If you're still using an older Redmine, checkout tag v3.2.2 for Redmine 3.x or even the ancient `redmine-2.x` branch.\n\nAs of 4.1.x, this plugin can now coexist with the Redmine CRM plugin.\n\n## Introduction\n\n[![Join the chat at https://gitter.im/alexbevi/redmine_knowledgebase](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/alexbevi/redmine_knowledgebase?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n\u003ca href=\"http://www.packtpub.com/redmine-plugin-extension-and-development/book\" target =\"_blank\"\u003e\n\u003cimg align=\"right\" src=\"http://www.alexbevi.com/images/8748OS_mockupcover_normal_0.jpg\" alt=\"Redmine Plugin Extension and Development\"\u003e\n\u003c/a\u003e\n\n[Redmine](http://www.redmine.org) is just plain awesome, and has proven to provide 90% of the functionality I need. The one feature that was missing was a usable knowledgebase component. I've looked at some of the open source solutions available, but couldn't find anything that fit my needs exactly. Seeing as Redmine is so easily extended, I figured why not create it for this platform instead of starting yet another project from scratch :P\n\n**SHAMELESS PLUG** This plugin is discussed in [Redmine Plugin Extension and Development](https://www.packtpub.com/product/redmine-plugin-extension-and-development/9781783288748), which is now available from Packt Publishing. \n\n## Features\n\n* Article versioning\n* View differences between versions\n* Email notifications and atom feeds\n* Categorization of articles\n* Article ratings\n* File attachments\n* Comment on articles\n* Article tagging\n* Visual indexes with thumbnails (optional)\n* Project-based permissions\n\n## Installation\n\nTo install the knowledgebase, execute the following commands from the root of your redmine directory, assuming that your RAILS_ENV enviroment variable is set to \"production\":\n\n    git clone git://github.com/alexbevi/redmine_knowledgebase.git plugins/redmine_knowledgebase\n    bundle install\n    rake redmine:plugins:migrate NAME=redmine_knowledgebase\n\nMore information on installing Redmine plugins can be found here: [http://www.redmine.org/wiki/redmine/Plugins](http://www.redmine.org/wiki/redmine/Plugins \"Redmine Plugins\")\n\nAfter the plugin is installed and the db migration completed, you will\nneed to restart Redmine for the plugin to be available.\n\n### Updating from v2.3.0 (Should work for all 2.x versions but has not been tested)\n\nTo update redmine from v2.3.0 to 3.0+ you will first want to delete ``redmine_knowledgebase`` from the the ``/plugins`` and ``/public/plugin_assets`` directories. \n\nOnce those two directories have been removed, run the following commands (as though you were performing a fresh installation):\n\n    git clone git://github.com/alexbevi/redmine_knowledgebase.git plugins/redmine_knowledgebase\n    bundle install\n    rake redmine:plugins:migrate NAME=redmine_knowledgebase\n  \nUpon restarting Redmine, the Knowledgebase entry will no longer appear as a [:top_menu](http://www.redmine.org/projects/redmine/wiki/Plugin_Tutorial#Extending-menus) entry.\n\nThe knowledgebase is now project-specific, and therefore must be included in at least one project to work properly. If you wish to use it like v2.x, you can make a [public project](http://www.redmine.org/projects/redmine/wiki/RedmineProjectSettings#General-settings) that will only be used to store knowledgebase articles.\n\nYou will need to go into your database now and change the ``kb_articles`` and ``kb_categories`` ``project_id`` to the project id of the knowledgebase project you just created. \n\nYou can find the id in the projects table.\n\nTo generate the full project list from the command line, you can run the following from the root of your Redmine installation: \n\n```ruby\nrails runner \"Project.all.map { |p| puts \\\"#{p.id}\\t#{p.name}\\\" }\"\n```\n\nThis will produce a list similar to:\n\n    3    Plugin Development\n    4    KB 2.x\n    5    Global\n\nIf you want to move all existing categories to the above \"Global\" project, you could do this via:\n\n```ruby\nrails runner \"KbCategory.update_all(\\\"project_id = 5\\\")\"\nrails runner \"KbArticle.update_all(\\\"project_id = 5\\\")\"\n```\n\n### Uninstall\n\n    rake redmine:plugins:migrate NAME=redmine_knowledgebase VERSION=0\n\n## User Guide\n\n### Overview\n\nOnce the Redmine Knowledgebase Plugin is installed, you will need to add the knowledgebase module to an existing or new project. Once you do so, there will be a Knowledgebase link in the Project menu bar.\n\n### Configuration\n\nTo start using the Knowledgebase plugin, click on the Knowledgebase link\nin the Project menu bar.\n\nThis takes you to the Knowledgebase home page. Because no articles or categories exist,\nyou will see this message: *\"No categories have been created. Click Create Category to get started.\"*. To the\nright is a green circle with a plus (+) sign, and the link to create a new\nCategory.\n\nClick on **Create Category**. This takes you to the Create Category page.\n\n* **Root Category** - since this is the first category, this is checked by\ndefault. Root categories show in the right hand *Browse by Category*\nsidebar.\n\n* **Title** - give the new category a title relevant to your needs. This title\nwill show in the *Browse by Category* sidebar as a navigation link.\n\n* **Description** - provide a description of the category. This description\nwill show on the category main page.\n\nClick on **Create** to create the new category. You can edit this\ninformation again once the category is created by using the Edit link on\nthe category main page.\n\nThe first category created is the parent category for all new\ncategories.\n\nYou can continue to create as many new categories as needed, and add\nmore new categories at any time. See *Using\nthe Knowledgebase* for information on how to create sub-categories and add\narticles.\n\nOnce you have added categories to the Knowledgebase, there will be a\n*Jump to Category* drop down menu on the Knowledgebase home page. You can\nuse that to navigate to any category or sub-category. You can also\nnavigate to categories (not sub-categories) by clicking on the category\nname in the right hand *Browse by Category* side bar.\n\n### Using the Knowledgebase\n\nOnce you have created categories, you can then add articles and\nsub-categories.\n\n#### Creating Sub-categories\n\nTo create a sub-category, click on a root category in the right hand\n*Browse by Category* sidebar, or use the *Jump to Category* drop down menu\nfrom the Knowledgebase Home page.\n\nOnce you are on the main page for that category, click on the **New\nCategory** link on the right side of the page. This takes you to the\n*Create Category* page.\n\n* **Root Category** - uncheck this box if you want this to be a sub-category\n\n* **Parent Category** - choose the relevant parent category from the drop down\nmenu. This option only appears if the *Root Category* checkbox is un-checked.\n\n* **Title** - give the new sub-category a title relevant to your needs.\n\n* **Description** - provide a description for the sub-category. This\ndescription will appear on the sub-category main page.\n\nClick on **Create** to create the new sub-category. You can edit this\ninformation again by using the Edit link on the sub-category main page.\n\nYou can have sub-categories of sub-categories.\n\n**NOTE** - sub-categories do not appear in the right hand *Browse by Category*\nside bar. Sub-categories only appear in the *Jump to Category* drop down\nmenu on the Knowledgebase Home page, or in the category main pages.\n\nIn the *Jump to Category* drop down menu, sub-categories are shown with a\nleading \u003e , sub sub-categories with a leading \u003e\u003e , etc.\n\n\n#### Creating Articles\n\nTo create an Article, click on the **Create Article** link on the home page, or navigate to a category or sub-category, and click\non the **Create Article** link. This opens the *Create Article* page.\n\n* **Category** - select the category or sub-category from the drop down menu\n\n* **Title** - give the article a relevant title\n\n* **Summary** - a short summary of what the article is about. This shows under\nthe article on the category or sub-category main page.\n\n* **Content** - the content of the article. The Content section uses the\nRedmine Wiki formatting syntax, so anything that is possible in the\nRedmine Wiki is possible here.\n\n* **Tags** - add tags to the article Separate tags or tag groups with commas. Global tag search is currently not implemented, but is in development. Tag search is currently only available at the Article level.\n\n* **Change Comments** - This field enables you to record the changes made to the article each time you edit it. This comment, along with the date, time, and author/updater, will show in the article history table at the top of each article.\n\n* **Files** - attach any files or images to the article, along with an optional description. Note that the maximum size of the files or images that can be uploaded is 5MB.\n\nClick on **Create** to add the article. Click on **Preview** to see how the article content will look and make any necessary changes before creating the article.\n\n#### Managing Articles\n\nOnce you click on **Create** to add the article, the article is displayed. This page shows the title, summary and content of the article, the creator (Added by username), how long ago the article was created, and how many times it has been viewed.\n\nYou can also Edit or Delete the article, as well as rate the article. Clicking on any of the tags in the Tags section will search for any other articles with the same tags.\n\nYou can also comment on an article by clicking on Add a comment.\n\nWhen editing the article, you will once again be able to enter a change comment as to what changed with this version of the article. This is useful to others who may be watching the article, and will allow them to get a brief idea of what change you made. They will also be able to see previous versions of the article if you allow them to, view highlighted differences between them, and revert to previous versions, if they have permission.\n\nIf you **Watch** the article, you will receive email notifications if the article is updated, deleted, or a comment is added. You can also watch an entire category, to be notified if any document in that category is created, edited, deleted, or commented on. You can also subscribe to atom feeds on article categories.\n\n#### Using Wiki Macros\n\nYou can easily create links to articles and categories from issues or Wiki pages using the macros.\n\n4 macros are available so far:\n\n* `{{kb(\u003carticle_id\u003e)}}` will render a link to the \"kb#\u003carticle_id\u003e\" format. (It may change according to your locale).\n* `{{article_id(\u003carticle_id\u003e)}}`, identical to the kb macro, will render a link to the \"kb#\u003carticle_id\u003e\" format.\n* `{{article(\u003carticle_id\u003e)}}` will render a link to the \"kb#\u003carticle_id\u003e: \u003carticle_title\u003e\" format.\n* `{{category(\u003ccategory_id\u003e)}}` will render a link to the \"\u003ccategory_title\u003e\" format, only renders the title of the category.\n\n### Knowledgebase Home Page\n\nNow that categories and articles have been created, the home page of the Knowledgebase will show lists of *Recently Updated Articles*, *Most Popular Articles*, and *Top Rated Articles*. You can adjust permissions to enable users to view these lists, or change how many documents are displayed in these lists. You can use this page to help navigate the Knowledgebase, as well as using the *Jump to Category* drop down menu or the *Browse by Category* menu on the right of the screen. You can reach this page from anywhere inside the Knowledgebase by clicking on the Home link.\n\n### About\n\n* Released under the MIT license.  See LICENSE file.\n* Copyright (c) 2010-2016 Alex Bevilacqua, original author.\n* Modifications (c) 2016-2018 Rob Spearman.\n\nThis plugin would not be possible without the many contributions from the community. See [AUTHORS](https://github.com/alexbevi/redmine_knowledgebase/blob/master/AUTHORS) for the full list.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexbevi%2Fredmine_knowledgebase","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexbevi%2Fredmine_knowledgebase","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexbevi%2Fredmine_knowledgebase/lists"}