From 0eaea3371092769066a38af4aed498e6adb7cf75 Mon Sep 17 00:00:00 2001 From: Andy Zhao <17884966+Zhao-Andy@users.noreply.github.com> Date: Wed, 23 Jun 2021 15:01:01 -0400 Subject: [PATCH] Replace admin guide links (#13967) * Replace admin guide links * Add missing /docs/ * Add proper links --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- .../admin/application_controller.rb | 24 +++++++++---------- app/views/admin/overview/index.html.erb | 18 +++++++------- app/views/layouts/admin.html.erb | 2 +- spec/tasks/metrics_spec.rb | 2 +- 5 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e9cbe2932..b0fb337a9 100644 --- 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 index dc442425b..736d91a45 100644 --- a/app/controllers/admin/application_controller.rb +++ b/app/controllers/admin/application_controller.rb @@ -5,18 +5,18 @@ module Admin 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 index 7fdc9b51c..041d04d83 100644 --- a/app/views/admin/overview/index.html.erb +++ b/app/views/admin/overview/index.html.erb @@ -8,17 +8,17 @@

Welcome Checklist

Here are a few things we recommend doing now that you're using Forem!

    -
  1. Set up and configure your Forem under <%= link_to "Config", admin_config_path, 'data-action': "click->ahoy#trackOverviewLink" %>
    2. -
  2. <%= link_to "Invite people", admin_invitations_path, 'data-action': "click->ahoy#trackOverviewLink" %> to join your Forem
    3. -
  3. <%= link_to "Update your Forem tags", admin_tags_path, 'data-action': "click->ahoy#trackOverviewLink" %>
    4. -
  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" %>
    5. -
  5. Read the Quick Start Guide
    6. -
  6. <%= link_to "Set up a Welcome Thread", admin_welcome_index_path, 'data-action': "click->ahoy#trackOverviewLink" %>
    7. -
  7. Browse the Forem Admin Guide
    8. +
  8. Set up and configure your Forem under <%= link_to "Config", admin_config_path, "data-action": "click->ahoy#trackOverviewLink" %>
    9. +
  9. <%= link_to "Invite people", admin_invitations_path, "data-action": "click->ahoy#trackOverviewLink" %> to join your Forem
    10. +
  10. <%= link_to "Update your Forem tags", admin_tags_path, "data-action": "click->ahoy#trackOverviewLink" %>
    11. +
  11. <%= 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" %>
    12. +
  12. Read the Quick Start Guide
    13. +
  13. <%= link_to "Set up a Welcome Thread", admin_welcome_index_path, "data-action": "click->ahoy#trackOverviewLink" %>
    14. +
  14. Browse the Forem Admin Guide
  15. Join forem.dev to learn from fellow Forem creators.
- Visit Forem Admin Guide + Visit Forem Admin Guide
@@ -46,7 +46,7 @@ This guide gives you the best practices on how you can manage and grow your community on Forem.

- Visit Guide + Visit Guide
diff --git a/app/views/layouts/admin.html.erb b/app/views/layouts/admin.html.erb index cdb1f04e8..1be2e3527 100644 --- a/app/views/layouts/admin.html.erb +++ b/app/views/layouts/admin.html.erb @@ -39,7 +39,7 @@
- diff --git a/spec/tasks/metrics_spec.rb b/spec/tasks/metrics_spec.rb index 5e05b7440..1d0330511 100644 --- a/spec/tasks/metrics_spec.rb +++ b/spec/tasks/metrics_spec.rb @@ -8,7 +8,7 @@ RSpec.describe "Metrics Overview task", type: :task do 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