Skip to content

DEV: Add site description to crawler homepage view #32845

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 21, 2025
Merged

DEV: Add site description to crawler homepage view #32845

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
535bd8f
DEV: Add site description to crawler homepage view
pmusaraj May 21, 2025
7d77cbb
Fix specs following review
pmusaraj May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions app/controllers/application_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ def use_crawler_layout?
CrawlerDetection.crawler?(request.user_agent, request.headers["HTTP_VIA"])
)
end
helper_method :use_crawler_layout?

def perform_refresh_session
refresh_session(current_user) unless @readonly_mode
Expand Down
3 changes: 3 additions & 0 deletions app/helpers/application_helper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,9 @@ def description_content
)
end

def is_crawler_homepage?
request.path == "/" && use_crawler_layout?
end
# Creates open graph and twitter card meta data
def crawlable_meta_data(opts = nil)
opts ||= {}
Expand Down
7 changes: 4 additions & 3 deletions app/views/layouts/_noscript_header.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<header>
<a href="<%= path "/" %>">
<%=SiteSetting.title%>
</a>
<a href="<%= path "/" %>"><%=SiteSetting.title%></a>
<% if is_crawler_homepage? %>
<p><%= SiteSetting.site_description %></p>
<% end %>
</header>
28 changes: 27 additions & 1 deletion spec/requests/home_page_controller_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# frozen_string_literal: true

RSpec.describe HomePageController do
describe "#custom" do
describe "homepage" do
context "with crawler view" do
before do
SiteSetting.site_description = "This is a test description"
SiteSetting.has_login_hint = false
end

it "should display the menu by default" do
get "/custom", headers: { "HTTP_USER_AGENT" => "Googlebot" }

Expand Down Expand Up @@ -43,6 +48,27 @@ def enabled?
DiscoursePluginRegistry.reset!
end
end

it "should display the site description on the homepage" do
get "/", headers: { "HTTP_USER_AGENT" => "Googlebot" }

expect(response.status).to eq(200)
expect(response.body).to include("<p>This is a test description</p>")
expect(response.body).to include(
"<meta name=\"description\" content=\"This is a test description\">",
)
end

it "should not display the site description on another route" do
get "/top", headers: { "HTTP_USER_AGENT" => "Googlebot" }

expect(response.status).to eq(200)
expect(response.body).not_to include("<p>This is a test description</p>")
# but still includes the meta tag
expect(response.body).to include(
"<meta name=\"description\" content=\"This is a test description\">",
)
end
end
end
end
Loading