FEATURE: Rename from Knowledge Explorer to Docs (#27)

After internal discussion, the team decided to rename this plugin to `discourse-docs`. No substantial changes made here aside from a settings migration.

Author: justindirose

app/controllers/knowledge_explorer/knowledge_explorer_controller.rb renamed to app/controllers/docs/docs_controller.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-module KnowledgeExplorer
-  class KnowledgeExplorerController < ApplicationController
-    requires_plugin 'knowledge-explorer'
+module Docs
+  class DocsController < ApplicationController
+    requires_plugin 'docs'
 
     skip_before_action :check_xhr, only: [:index]
 
@@ -18,7 +18,7 @@ def index
         page: params[:page]
       }
 
-      query = KnowledgeExplorer::Query.new(current_user, filters).list
+      query = Docs::Query.new(current_user, filters).list
 
       if filters[:topic].present?
         begin
@@ -45,21 +45,20 @@ def index
     end
 
     def get_topic(topic, current_user)
-      return nil unless topic_in_explorer(topic.category_id, topic.tags)
+      return nil unless topic_in_docs(topic.category_id, topic.tags)
 
       topic_view = TopicView.new(topic.id, current_user)
       guardian = Guardian.new(current_user)
 
       TopicViewSerializer.new(topic_view, scope: guardian, root: false)
     end
 
-    def topic_in_explorer(category, tags)
-      category_match = KnowledgeExplorer::Query.categories.include?(category.to_s)
+    def topic_in_docs(category, tags)
+      category_match = Docs::Query.categories.include?(category.to_s)
       tags = tags.pluck(:name)
-      tag_match = KnowledgeExplorer::Query.tags.any? { |tag| tags.include?(tag) }
+      tag_match = Docs::Query.tags.any? { |tag| tags.include?(tag) }
 
       category_match || tag_match
     end
-
   end
 end

app/views/connectors/robots_txt_index/docs.html.erb

@@ -0,0 +1,4 @@
+<%- if SiteSetting.docs_enabled%>
+User-agent: *
+Disallow: /docs/
+<% end %>

app/views/connectors/robots_txt_index/knowledge-explorer.html.erb

@@ -3,7 +3,7 @@ import { debounce } from "@ember/runloop";
 import discourseDebounce from "discourse-common/lib/debounce";
 
 export default Component.extend({
-  classNames: "knowledge-explorer-search",
+  classNames: "docs-search",
 
   debouncedSearch(term) {
     // TODO: Use discouseDebounce when discourse 2.7 gets released.

app/views/knowledge_explorer/knowledge_explorer/get_topic.html.erb renamed to app/views/docs/docs/get_topic.html.erb

@@ -2,7 +2,7 @@ import Component from "@ember/component";
 import discourseComputed from "discourse-common/utils/decorators";
 
 export default Component.extend({
-  classNames: "knowledge-explorer-topic-list",
+  classNames: "docs-topic-list",
   @discourseComputed("order")
   sortTitle(order) {
     return order === "title";
@@ -15,7 +15,7 @@ export default Component.extend({
 
   // need to handle clicks here since links are in a raw view
   click(e) {
-    if (e.target.classList.contains("knowledge-explorer-topic-link")) {
+    if (e.target.classList.contains("docs-topic-link")) {
       const topicId = e.target.dataset.topicId;
       this.selectTopic(topicId);
       return false;

assets/javascripts/discourse/components/knowledge-explorer-category.js.es6 renamed to assets/javascripts/discourse/components/docs-category.js.es6

@@ -3,7 +3,7 @@ import { reads } from "@ember/object/computed";
 import { computed } from "@ember/object";
 
 export default Component.extend({
-  classNames: "knowledge-explorer-topic",
+  classNames: "docs-topic",
 
   originalPostContent: reads("post.cooked"),
 
@@ -27,16 +27,12 @@ export default Component.extend({
   didInsertElement() {
     this._super(...arguments);
 
-    document
-      .querySelector("body")
-      .classList.add("archetype-knowledge-explorer-topic");
+    document.querySelector("body").classList.add("archetype-docs-topic");
   },
 
   willDestroyElement() {
     this._super(...arguments);
 
-    document
-      .querySelector("body")
-      .classList.remove("archetype-knowledge-explorer-topic");
+    document.querySelector("body").classList.remove("archetype-docs-topic");
   },
 });

assets/javascripts/discourse/components/knowledge-explorer-search.js.es6 renamed to assets/javascripts/discourse/components/docs-search.js.es6

@@ -3,7 +3,7 @@ import { inject } from "@ember/controller";
 import discourseComputed from "discourse-common/utils/decorators";
 import { alias, readOnly, equal } from "@ember/object/computed";
 import { on } from "discourse-common/utils/decorators";
-import KnowledgeExplorer from "discourse/plugins/discourse-knowledge-explorer/discourse/models/knowledge-explorer";
+import Docs from "discourse/plugins/discourse-docs/discourse/models/docs";
 import { getOwner } from "@ember/application";
 
 export default Controller.extend({
@@ -69,7 +69,7 @@ export default Controller.extend({
   canFilterSolved() {
     return (
       this.siteSettings.solved_enabled &&
-      this.siteSettings.knowledge_explorer_add_solved_filter
+      this.siteSettings.docs_add_solved_filter
     );
   },
 
@@ -157,7 +157,7 @@ export default Controller.extend({
       if (this.canLoadMore && !this.isLoadingMore) {
         this.set("isLoadingMore", true);
 
-        KnowledgeExplorer.loadMore(this.loadMoreUrl).then((result) => {
+        Docs.loadMore(this.loadMoreUrl).then((result) => {
           const topics = this.topics.concat(result.topics.topic_list.topics);
 
           this.setProperties({
@@ -179,7 +179,7 @@ export default Controller.extend({
 
     returnToList() {
       this.set("selectedTopic", null);
-      getOwner(this).lookup("router:main").transitionTo("knowledgeExplorer");
+      getOwner(this).lookup("router:main").transitionTo("docs");
     },
   },
 });