Skip to content

Commit f27299c

Browse files
authored
Configure search result optimizations (#1001)
* Configure search result optimizations * Try un-numbering Juniper pages * Put quickstarts as high priority * Deprioritize glossary * Retitle dev guide for SEO
1 parent 7b4017c commit f27299c

3 files changed

Lines changed: 47 additions & 4 deletions

File tree

.readthedocs.yaml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,47 @@ build:
2727
python:
2828
install:
2929
- requirements: requirements/base.txt
30+
31+
# Optimize search results https://docs.readthedocs.com/platform/stable/config-file/v2.html#search-ranking
32+
33+
search:
34+
ranking:
35+
# The rank can be an integer number between -10 and 10 (inclusive). Pages
36+
# with a rank closer to -10 will appear further down the list of results,
37+
# and pages with a rank closer to 10 will appear higher in the list of
38+
# results. Note that 0 means normal rank, not no rank.
39+
40+
# Deprioritize old release pages
41+
birch.html: -10
42+
cypress.html: -10
43+
dogwood.html: -10
44+
eucalyptus.html: -10
45+
ficus.html: -10
46+
ginkgo.html: -10
47+
hawthorn.html: -10
48+
ironwood.html: -10
49+
juniper.html: -10
50+
juniper_developer.html: -10
51+
juniper_learner.html: -10
52+
juniper_educator.html: -10
53+
koa.html: -8
54+
lilac.html: -8
55+
maple.html: -7
56+
nutmeg.html: -5
57+
palm.html: -5
58+
glossary.html: -5
59+
60+
# Match all files under the api/v1 directory
61+
#api/v1/*: -5
62+
developers/references/developer_guide/*.html: 10
63+
developers/quickstarts/*.html: 10
64+
educators/quickstarts/*.html: 10
65+
site_ops/quickstarts/*.html: 10
66+
documentors/quickstarts/*.html: 10
67+
translators/quickstarts/*.html: 10
68+
69+
70+
# Match all files named guides.html,
71+
# two patterns are needed to match both the root and nested files.
72+
#'guides.html': 3
73+
#'*/guides.html': 3

source/community/release_notes/juniper.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ areas, along with a way to jump down to each section of the release notes.
1414
.. _Open edX Platform: https://open.edx.org
1515

1616
.. toctree::
17-
:numbered: 3
1817
:hidden:
1918

2019
juniper_learner

source/developers/references/developer_guide/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
.. _Open edX Developer's Guide:
22

3-
##########################
4-
Open edX Developer's Guide
5-
##########################
3+
##############################
4+
Developer's Guide for Open edX
5+
##############################
66

77
Welcome to the Open edX Developer's Guide. This guide should be
88
used as a reference manual; it covers everything from high level

0 commit comments

Comments
 (0)