Replace admin guide links (forem#13967)

* Replace admin guide links * Add missing /docs/ * Add proper links
GeauxWeisbeck4 · Jun 23, 2021 · 0eaea33 · 0eaea33
1 parent 69a03c8
commit 0eaea33
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 24 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -57,7 +57,7 @@ development process, or any of our internal teams? If so, please note how you
 will share this change with the people who need to know about it._
 
 - [ ] I've updated the [Developer Docs](https://docs.forem.com) and/or
-      [Admin Guide](https://forem.gitbook.io/forem-admin-guide/), or
+      [Admin Guide](https://admin.forem.com/), or
       [Storybook](https://storybook.forem.com/) (for Crayons components)
 - [ ] I've updated the README or added inline documentation
 - [ ] I will share this change in a [Changelog](https://forem.dev/t/changelog)

diff --git a/app/controllers/admin/application_controller.rb b/app/controllers/admin/application_controller.rb
@@ -5,18 +5,18 @@ class ApplicationController < ApplicationController
     after_action :verify_authorized
 
     HELP_URLS = {
-      badges: "https://forem.gitbook.io/forem-admin-guide/admin/badges",
-      badge_achievements: "https://forem.gitbook.io/forem-admin-guide/admin/badges",
-      configs: "https://forem.gitbook.io/forem-admin-guide/admin/config",
-      navigation_links: "https://forem.gitbook.io/forem-admin-guide/admin/navigation-links",
-      pages: "https://forem.gitbook.io/forem-admin-guide/admin/pages",
-      podcasts: "https://forem.gitbook.io/forem-admin-guide/admin/podcasts",
-      reports: "https://forem.gitbook.io/forem-admin-guide/admin/reports",
-      users: "https://forem.gitbook.io/forem-admin-guide/admin/users",
-      html_variants: "https://forem.gitbook.io/forem-admin-guide/admin/html-variants",
-      display_ads: "https://forem.gitbook.io/forem-admin-guide/admin/display-ads",
-      chat_channels: "https://forem.gitbook.io/forem-admin-guide/admin/chat-channels",
-      tags: "https://forem.gitbook.io/forem-admin-guide/admin/tags"
+      badges: "https://admin.forem.com/docs/admin/badges",
+      badge_achievements: "https://admin.forem.com/docs/admin/badges",
+      configs: "https://admin.forem.com/docs/admin/config/README",
+      navigation_links: "https://admin.forem.com/docs/admin/navigation-links",
+      pages: "https://admin.forem.com/docs/admin/pages",
+      podcasts: "https://admin.forem.com/docs/admin/podcasts",
+      reports: "https://admin.forem.com/docs/admin/reports",
+      users: "https://admin.forem.com/docs/admin/users/README",
+      html_variants: "https://admin.forem.com/docs/admin/html-variants",
+      display_ads: "https://admin.forem.com/docs/admin/display-ads",
+      chat_channels: "https://admin.forem.com/docs/admin/chat-channels",
+      tags: "https://admin.forem.com/docs/admin/tags"
     }.freeze
 
     private

diff --git a/app/views/admin/overview/index.html.erb b/app/views/admin/overview/index.html.erb
@@ -8,17 +8,17 @@
         <h3 class="crayons-subtitle-1">Welcome Checklist</h3>
         <p class="crayons-subtitle-4 color-base-70 mb-3">Here are a few things we recommend doing now that you're using Forem!</p>
         <ol>
-          <li class="mb-1 -ml-4">Set up and configure your Forem under <%= link_to "Config", admin_config_path, 'data-action': "click->ahoy#trackOverviewLink" %></li>
-          <li class="mb-1 -ml-4"><%= link_to "Invite people", admin_invitations_path, 'data-action': "click->ahoy#trackOverviewLink" %> to join your Forem</li>
-          <li class="mb-1 -ml-4"><%= link_to "Update your Forem tags", admin_tags_path, 'data-action': "click->ahoy#trackOverviewLink" %></li>
-          <li class="mb-1 -ml-4"><%= link_to "Create pages", admin_pages_path, 'data-action': "click->ahoy#trackOverviewLink" %> and <%= link_to "sort them in the navigation sidebar", admin_navigation_links_path, 'data-action': "click->ahoy#trackOverviewLink" %></li>
-          <li class="mb-1 -ml-4">Read the <a href="https://forem.gitbook.io/forem-admin-guide/quick-start-guide" data-action="click->ahoy#trackOverviewLink">Quick Start Guide</a></li>
-          <li class="mb-1 -ml-4"><%= link_to "Set up a Welcome Thread", admin_welcome_index_path, 'data-action': "click->ahoy#trackOverviewLink" %></li>
-          <li class="mb-1 -ml-4">Browse the <a href="https://forem.gitbook.io/forem-admin-guide" data-action="click->ahoy#trackOverviewLink">Forem Admin Guide</a></li>
+          <li class="mb-1 -ml-4">Set up and configure your Forem under <%= link_to "Config", admin_config_path, "data-action": "click->ahoy#trackOverviewLink" %></li>
+          <li class="mb-1 -ml-4"><%= link_to "Invite people", admin_invitations_path, "data-action": "click->ahoy#trackOverviewLink" %> to join your Forem</li>
+          <li class="mb-1 -ml-4"><%= link_to "Update your Forem tags", admin_tags_path, "data-action": "click->ahoy#trackOverviewLink" %></li>
+          <li class="mb-1 -ml-4"><%= link_to "Create pages", admin_pages_path, "data-action": "click->ahoy#trackOverviewLink" %> and <%= link_to "sort them in the navigation sidebar", admin_navigation_links_path, "data-action": "click->ahoy#trackOverviewLink" %></li>
+          <li class="mb-1 -ml-4">Read the <a href="https://admin.forem.com/docs/quick-start-guide" data-action="click->ahoy#trackOverviewLink">Quick Start Guide</a></li>
+          <li class="mb-1 -ml-4"><%= link_to "Set up a Welcome Thread", admin_welcome_index_path, "data-action": "click->ahoy#trackOverviewLink" %></li>
+          <li class="mb-1 -ml-4">Browse the <a href="https://admin.forem.com" data-action="click->ahoy#trackOverviewLink">Forem Admin Guide</a></li>
           <li class="-ml-4">Join <a href="https://forem.dev">forem.dev</a> to learn from fellow Forem creators.</li>
         </ol>
         <div class="align-center">
-          <a class="crayons-btn crayons-btn--ghost-brand" href="https://forem.gitbook.io/forem-admin-guide" data-action="click->ahoy#trackOverviewLink">Visit Forem Admin Guide</a>
+          <a class="crayons-btn crayons-btn--ghost-brand" href="https://admin.forem.com" data-action="click->ahoy#trackOverviewLink">Visit Forem Admin Guide</a>
         </div>
       </div>
     </section>
@@ -46,7 +46,7 @@
             This guide gives you the best practices on how you can manage and
             grow your community on Forem.
           </p>
-          <a role="button" href="https://forem.gitbook.io/forem-admin-guide" class="crayons-btn mt-1 w-100 self-end" data-action="click->ahoy#trackOverviewLink">Visit Guide</a>
+          <a role="button" href="https://admin.forem.com" class="crayons-btn mt-1 w-100 self-end" data-action="click->ahoy#trackOverviewLink">Visit Guide</a>
         </div>
       </section>
       <section class="crayons-card">

diff --git a/app/views/layouts/admin.html.erb b/app/views/layouts/admin.html.erb
@@ -39,7 +39,7 @@
       </h1>
 
       <div class="flex items-center h-100 ml-auto">
-        <a href="https://forem.gitbook.io/forem-admin-guide/" class="crayons-btn crayons-btn--ghost-brand hidden mr-2 whitespace-nowrap s:block">
+        <a href="https://admin.forem.com/" class="crayons-btn crayons-btn--ghost-brand hidden mr-2 whitespace-nowrap s:block">
           Forem Admin Guide
         </a>
 

diff --git a/spec/tasks/metrics_spec.rb b/spec/tasks/metrics_spec.rb
@@ -8,7 +8,7 @@
 
   describe "#overview" do
     let(:event_name) { "Admin Overview Link Clicked" }
-    let(:click_target) { "https://forem.gitbook.io/forem-admin-guide/quick-start-guide" }
+    let(:click_target) { "https://admin.forem.com/docs/quick-start-guide" }
     let(:host) { ENV["APP_DOMAIN"] }
 
     it "returns the event count and target for admin overview events" do