From 9ed9032150df336fa385ca36b6a45ac0acd05912 Mon Sep 17 00:00:00 2001 From: Jordan Vidrine <30537603+jordanvidrine@users.noreply.github.com> Date: Mon, 9 Sep 2024 08:55:42 -0500 Subject: [PATCH] FIX: Requested changes from dev (#28784) * FIX: Requested changes from dev * FIX: Add base-url to other links --------- Co-authored-by: Martin Brennan --- docs/ADMIN-QUICK-START-GUIDE.md | 44 ++++++++++++++++----------------- lib/seed_data/topics.rb | 4 ++- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/docs/ADMIN-QUICK-START-GUIDE.md b/docs/ADMIN-QUICK-START-GUIDE.md index 9bb598df8e0..b61d48f6e74 100644 --- a/docs/ADMIN-QUICK-START-GUIDE.md +++ b/docs/ADMIN-QUICK-START-GUIDE.md @@ -6,11 +6,11 @@ Discourse is a powerful and flexible platform with many options for customizatio To get started, we recommend you follow the sections below for each of the following: -- [ ] [Test your email configuration](/admin/email) -- [ ] [Complete the setup wizard](/wizard/steps/branding) -- [ ] [Invite a few people to join you](/my/invited) -- [ ] [Discuss ideas with your community](/new-topic) -- [ ] [Adjust other customizations](/admin/site_settings/category/required) +- [ ] [Test your email configuration](%{base_url}/admin/email) +- [ ] [Complete the setup wizard](%{base_url}/wizard/steps/branding) +- [ ] [Invite a few people to join you](%{base_url}/my/invited) +- [ ] [Discuss ideas with your community](%{base_url}/new-topic) +- [ ] [Adjust other customizations](%{base_url}/admin/site_settings/category/required) - [ ] Update your welcome topic and guidelines - [ ] Repeat! - [ ] Launch your community @@ -19,7 +19,7 @@ To get started, we recommend you follow the sections below for each of the follo ## :email: Test your email configuration -Email is required for new account signups and notifications. **Test your email to make sure it is configured correctly!** Visit [the admin email settings](/admin/email), then enter an email address in the "email address to test" field and click send test email. +Email is required for new account signups and notifications. **Test your email to make sure it is configured correctly!** Visit [the admin email settings](%{base_url}/admin/email), then enter an email address in the "email address to test" field and click send test email. - You got the test email? Great! **Read that email closely**, it has important email deliverability tips. @@ -30,13 +30,13 @@ Email is required for new account signups and notifications. **Test your email t ## :magic_wand: Complete the setup wizard -You've already been through the setup wizard, but if you skipped some steps, you can go back now and update some basic settings at this link: [/wizard](/wizard). +You've already been through the setup wizard, but if you skipped some steps, you can go back now and update some basic settings at this link: [/wizard](%{base_url}/wizard). ## :handshake: Invite a few people to join you It's helpful to collaborate with at least one or two other people early that can provide feedback on the decisions you're making about your community. - **If your community allows people to freely sign up**, send them the link and ask them to join. -- **If your community is invite only**, go to [your invites page](/my/invited) and look for the + Invite button to create invite links you can share or directly email everyone you want to have in your community. +- **If your community is invite only**, go to [your invites page](%{base_url}/my/invited) and look for the + Invite button to create invite links you can share or directly email everyone you want to have in your community. > :bulb: Your community starts off in “bootstrap mode”, which gives early members [a higher level of trust ](https://blog.discourse.org/2018/06/understanding-discourse-trust-levels/)than the typical new member so they can help you launch your community. You can adjust how long your community remains in bootstrap mode [here](/admin/site_settings/category/all_results?filter=bootstrap). @@ -44,35 +44,35 @@ It's helpful to collaborate with at least one or two other people early that can Now that you have a few collaborators, you can start trying things out together and discussing ideas for your community. -To start a new discussion, click the + New Topic button on the [latest topics](/latest) page or within any of the following categories. +To start a new discussion, click the + New Topic button on the [latest topics](%{base_url}/latest) page or within any of the following categories. -- [#Site Feedback](/c/-/2) is for discussions about your site, how it works, and how you can improve it. It's designed to be open to participation by everyone who can access your community. +- [#Site Feedback](%{base_url}/c/-/2) is for discussions about your site, how it works, and how you can improve it. It's designed to be open to participation by everyone who can access your community. -- [#General](/c/-/4) is for topics of general interest to your community. You can create additional categories as you decide how you want to make space for different kinds of topics. +- [#General](%{base_url}/c/-/4) is for topics of general interest to your community. You can create additional categories as you decide how you want to make space for different kinds of topics. -- [#Staff](/c/-/3) is only visible to admins and moderators and can be used for topics you wish to discuss privately with other admins and moderators. +- [#Staff](%{base_url}/c/-/3) is only visible to admins and moderators and can be used for topics you wish to discuss privately with other admins and moderators. If you'd like to promote any members to become admins or moderators, visit their user page and click on the :wrench: Admin button, then click Grant Admin or Grant Moderator. -> :bulb: You can use [chat](/chat) for faster paced discussions. +> :bulb: You can use [chat](%{base_url}/chat) for faster paced discussions. ## :wave: Update your welcome topic and guidelines -Update the welcome topic in the [#General](/c/-/4) category and the community guidelines on your [FAQ](/faq) page as you see fit. Go through it yourself with your initial members and see if there's anything you want to add or change. +Update the welcome topic in the [#General](%{base_url}/c/-/4) category and the community guidelines on your [FAQ](%{base_url}/faq) page as you see fit. Go through it yourself with your initial members and see if there's anything you want to add or change. To get you started, think about what you want new members to **know about your community** or **do when they first join**. ## :art: Adjust other customizations -To customize the look and feel of your community beyond what you configured in the [setup wizard](/wizard), you can change the following settings in the [admin section](/admin): +To customize the look and feel of your community beyond what you configured in the [setup wizard](%{base_url}/wizard), you can change the following settings in the [admin section](/admin): -- [Logo images](/admin/site_settings/category/branding) -- [Color schemes](/admin/customize/colors) -- [Font styles](/admin/site_settings/category/all_results?filter=font) -- [Site theme](/admin/customize/themes) -- [Navigation menu](/admin/site_settings/category/navigation) -- [Custom user fields](/admin/customize/user_fields) -- [Terms of service and privacy policies](/admin/site_settings/category/legal) +- [Logo images](%{base_url}/admin/site_settings/category/branding) +- [Color schemes](%{base_url}/admin/customize/colors) +- [Font styles](%{base_url}/admin/site_settings/category/all_results?filter=font) +- [Site theme](%{base_url}/admin/customize/themes) +- [Navigation menu](%{base_url}/admin/site_settings/category/navigation) +- [Custom user fields](%{base_url}/admin/customize/user_fields) +- [Terms of service and privacy policies](%{base_url}/admin/site_settings/category/legal) [details="Advanced options"] diff --git a/lib/seed_data/topics.rb b/lib/seed_data/topics.rb index dc30483928c..08d2517efd6 100644 --- a/lib/seed_data/topics.rb +++ b/lib/seed_data/topics.rb @@ -263,7 +263,9 @@ module SeedData quick_start_filename = File.join(Rails.root, "docs", "ADMIN-QUICK-START-GUIDE.md") end - File.read(quick_start_filename) + content = File.read(quick_start_filename) + content.gsub!("%{base_url}", Discourse.base_url) + content end end end