Add guidelines/considerations for SEO to writing style section

Bug #1513270 reported by Linette Williams
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Wishlist
Linette Williams

Bug Description

I noticed that we don't give recommendations or considerations for titles, keywords, etc... to improve SEO results for new contributors. To promote successful SEO, I recommend adding the following best practices (with examples) to the writing style section.
- Avoid ambiguous titles
- Use consistent terminology
- Use spelling and grammar checking tools, if possible (primarily for larger, new topics)
- Be concise and clear (maybe move the "follow principles of minimalism" title into the description and make Be concise and clear the title?)

These simple guidelines make a big difference in SEO.
This bug only applies to the writing style section.
For future development, but not part of this bug, could consider a new bug to handle more in depth information.

-----------------------------------
Release: 1.0.0 on 2015-11-04 23:07
SHA: c2532135e3ba42937bc96e20581e51cc22fa5a73
Source: http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/contributor-guide/source/writing-style.rst
URL: http://docs.openstack.org/contributor-guide/writing-style.html

description: updated
Changed in openstack-manuals:
status: New → Confirmed
Revision history for this message
Anne Gentle (annegentle) wrote :

Sounds good. Be clear in this bug what you mean, with examples preferably, so that reviewers know when to call this bug fixed.

description: updated
description: updated
Revision history for this message
Linette Williams (stemke) wrote :

Thanks, Anne! I will definitely add examples. That's a good point.

description: updated
description: updated
description: updated
description: updated
description: updated
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to openstack-manuals (master)

Fix proposed to branch: master
Review: https://review.openstack.org/246510

Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to openstack-manuals (master)

Reviewed: https://review.openstack.org/246510
Committed: https://git.openstack.org/cgit/openstack/openstack-manuals/commit/?id=414dd6ccd5ffbe974ba4349a3fbebafc6313d0fe
Submitter: Jenkins
Branch: master

commit 414dd6ccd5ffbe974ba4349a3fbebafc6313d0fe
Author: Linette <email address hidden>
Date: Tue Nov 17 11:10:57 2015 -0600

    [Contributor Guide] Enhance writing style section

    Added 3 new sections to writing style section -
    avoid ambiguous titles, use consistent terms,
    use spelling tools when available. These sections
    can help improve SEO results for content.

    Change-Id: I0c83efc00529135028e2c560fbd7c19df9453787
    Closes-Bug: #1513270

Changed in openstack-manuals:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/openstack-manuals 15.0.0

This issue was fixed in the openstack/openstack-manuals 15.0.0 release.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.