Skip to content

Commit 827080c

Browse files
sarahemlincorryrootlindseymoore
authored
IA-related updates to SEO and metadata content (#169)
* added IA-related updates to SEO and metadata content * SEO, links, and URLs updates * Update source/style-guide/seo-guidelines.txt Co-authored-by: corryroot <[email protected]> * Update source/style-guide/seo-guidelines.txt Co-authored-by: lindseymoore <[email protected]> * Update source/style-guide/seo-guidelines.txt Co-authored-by: lindseymoore <[email protected]> --------- Co-authored-by: corryroot <[email protected]> Co-authored-by: lindseymoore <[email protected]>
1 parent ffe131c commit 827080c

File tree

4 files changed

+24
-10
lines changed

4 files changed

+24
-10
lines changed

source/style-guide/markup/directives/metadata.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,3 +43,15 @@ Overrides the document title.
4343

4444
Learn more about the ``title`` directive from the
4545
`{+docutils+} documentation <http://docutils.sourceforge.net/docs/ref/rst/directives.html#metadata-document-title>`__.
46+
47+
facet
48+
-----
49+
50+
Adds a taxonomy value of product, programming language, or genre.
51+
52+
.. code-block:: rst
53+
54+
.. facet::
55+
56+
Learn more about the ``facet`` directive from the
57+
`Taxonomy tagging instructions <https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions>`__.

source/style-guide/seo-guidelines.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Search Engine Optimization Guidelines
66

77
Search Engine Optimization (SEO) considers the actual terms that users
88
enter into search engines (keywords) and employs best practices to
9-
improve traffic to web pages from search engines. The following
9+
improve traffic to web pages from search engines. Close attention to page metadata and keywords in the page content can improve page placement in search results. The following
1010
guidance helps you to optimize your documentation pages for search.
1111

1212
.. important::
@@ -21,7 +21,7 @@ Keywords
2121
--------
2222

2323
You can add the actual terms that users enter into search engines
24-
(keywords) to the body of your page to improve its SEO.
24+
(keywords) to the body of your page to improve its SEO. Google Search Console provides details about the keywords our users enter and you can request this information from the IA and SEO teams.
2525

2626
.. important::
2727

@@ -66,8 +66,8 @@ Use the following SEO best practices for page and subsection titles:
6666

6767
- Avoid excessive or irrelevant words (keyword stuffing).
6868

69-
- Strive for unique page titles. Identical titles, even between
70-
documentation sets, might compete in search results.
69+
- Use unique page titles. Identical titles, even between
70+
documentation sets, compete in search results.
7171

7272
To learn more, see :ref:`titles-and-headings`.
7373

@@ -91,7 +91,7 @@ Descriptions
9191
------------
9292

9393
The description is a snippet that appears under the link in the search
94-
results, which can impact SEO. Write these descriptions according to
94+
results and is essential for SEO. Write these descriptions according to
9595
the following best practices:
9696

9797
- Use a concise description of the page content that is enticing, if

source/style-guide/style/links-and-cross-references.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ outside of the current page or section. Links may be:
2727
- :ref:`aggregation-expression-operators`
2828
- :ref:`aggregation-pipeline-operator-reference`
2929
- `Practical MongoDB Aggregations
30-
<https://www.practical-mongodb-aggregations.com>`__"
30+
<https://www.practical-mongodb-aggregations.com/>`__"
3131

3232
- Explicit hyperlinks to specific URLs. For example, a link to a GitHub
3333
repository.
@@ -122,7 +122,7 @@ link and where it will take them:
122122
- If a link will take a user away from the MongoDB documentation, such
123123
as to GitHub or Uncyclopedia, make the target site clear in the link
124124
text.
125-
- Avoid "Click here." It's bad for search engine optimization and
125+
- Avoid "Click here." It's bad for search engine optimization, screen readers, and
126126
doesn't adequately describe the target.
127127

128128
Link text should begin with the purpose of the cross-reference. For
@@ -179,6 +179,8 @@ refactor can potentially break links if the page is renamed or removed.
179179
Link and Cross-Reference Examples
180180
---------------------------------
181181

182+
All MongoDB URLs should have a trailing slash to match standards for canonical URLs used for SEO purposes.
183+
182184
.. list-table::
183185
:widths: 50 50
184186
:header-rows: 1

source/style-guide/style/urls.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ following domains for demonstration and documentation:
2525
The following URLs and email addresses would be acceptable in
2626
documentation:
2727

28-
- http://www.example.com
29-
- http://ldap.example.net
30-
- http://mongodb.example
28+
- http://www.example.com/
29+
- http://ldap.example.net/
30+
- http://mongodb.example/
3131
3232
3333

0 commit comments

Comments
 (0)