<font face="Default Sans Serif,Verdana,Arial,Helvetica,sans-serif" size="2"> <span><br></span><br><font color="#990099">-----Anne Gentle <<a target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a>> wrote: -----</font><div class="iNotesHistory" style="padding-left:5px;"><div style="padding-right:0px;padding-left:5px;border-left:solid black 2px;">To: Linette J Williams/Rochester/IBM@IBMUS<br>From: Anne Gentle <<a target="_blank" href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a>><br>Date: 11/08/2015 04:26PM<br>Cc: "<a target="_blank" href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>" <<a target="_blank" href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>><br>Subject: Re: [OpenStack-docs] OpenStack Documentation Contributor Guide - Idea for SEO considerations<br><br><div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Nov 5, 2015 at 8:40 AM, Linette J Williams <span dir="ltr"><<a href="mailto:stemke@us.ibm.com" target="_blank">stemke@us.ibm.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><font face="Default Sans Serif,Verdana,Arial,Helvetica,sans-serif" size="2"> <span><font face="Trebuchet MS,Default Sans Serif,Arial,Verdana,Helvetica,sans-serif" size="2">Hi everyone,<br>In reviewing the Contributor guide this week, I noticed that we don't say anything specific about SEO considerations for new contributions.<br>For example, title and keyword recommendations to consider when creating new content, etc...<br>I created a bug here with an idea --> <a href="https://bugs.launchpad.net/openstack-manuals/+bug/1513270" target="_blank">https://bugs.launchpad.net/openstack-manuals/+bug/1513270</a>  <br>Alexandra suggested I send to the mailing list for further discussion and Anne added some initial comments. Thank you both.<br><br>Does anyone have additional thoughts or suggestions on this topic? Do you agree it could be helpful? <br></font></span></font></blockquote><div><br></div><div>I think it could be helpful, but oddly when I originally saw the bug I thought you had ideas for what already is "wrong" with the site and SEO. So I was hoping you'd know how to fix it. :) I find it's one of our major complaints is searchability.<br><br><font size="2">--- Thanks for the additional information and your comments, Anne. :)  </font><font size="2"><font size="2">I, admittedly, do not know enough about the project yet to claim I know all of the SEO 
concerns or have a fix.;) (I wish I did!) </font>The example that initially jumped out to me was related to more thoughtful titles/keywords, thus my recommendations to enhance the writing style section of the contributor guide. Pretty low hanging fruit that could make an impact. I'm sure the team has already discussed SEO in great length before. I</font>f it's worth revisiting based on user feedback and the growing # of projects contributing, it could be a good group discussion at a future planning session too...<br><font face="Default Sans Serif,Verdana,Arial,Helvetica,sans-serif" size="2"><span><font face="Trebuchet MS,Default Sans Serif,Arial,Verdana,Helvetica,sans-serif" size="2"><br>Maybe you know of some useful tools/links to include in the content?  </font></span></font></div><div><br></div><div>Yes, I think that people writing for the docs site need to know:</div><div>- we generate a sitemap.xml every release (but it would be nice to automate it every build)</div><div>- we have a Google Custom Search Engine but it is controlled with a Foundation staff person's configuration, so we need to communicate with the Foundation when we want to suggest changes</div><div>- anything on the draft site should not be searchable/findable in Google</div><div>- because of Google's algorithm, the older releases get higher find hits for a while, but also realize that only two guides are "released" -- the install guides and config guides</div><div>- titles have a specific style and consistency guideline</div><div>- page names mimic the file name of the source and may also provide better SEO when written thoughtfully</div><div><font size="2"><br>--- Good to know about the custom search engine and the site map.  Thanks for raising these additional points to include.</font>  <br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><font face="Default Sans Serif,Verdana,Arial,Helvetica,sans-serif" size="2"><span><font face="Trebuchet MS,Default Sans Serif,Arial,Verdana,Helvetica,sans-serif" size="2">Specific guides that you notice could use attention?<br></font></span></font></blockquote><div><br></div><div>I think that the work going on to bring the admin user guide content together with the admin guide, specced at <a href="https://review.openstack.org/#/c/238770/">https://review.openstack.org/#/c/238770/</a>, will go a long way in helping people find what they seek.<br><br>--- I agree. Reducing duplication and streamlining those guides will be a great help.  Exciting work!  <br></div><div><br></div><div>We also have a big problem looming with 30+ projects writing docs to <a href="http://docs.openstack.org">docs.openstack.org</a> without any SEO considerations nor guidelines. Please keep in mind the myriad docs written that aren't sourced from openstack-manuals. We need a solution for not drowning out the best-written content.<br><br>Thanks for looking into this.  <br>  <br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><font face="Default Sans Serif,Verdana,Arial,Helvetica,sans-serif" size="2"><span><font face="Trebuchet MS,Default Sans Serif,Arial,Verdana,Helvetica,sans-serif" size="2"><br>Thanks in advance for looking at the bug and providing your feedback.  <br><br>With appreciation,</font><br>Linette<br><div dir="ltr" style="font-family:Arial;font-size:10.5pt"><div dir="ltr" style="margin-top:20px"><div style="font-size:12pt;font-weight:bold"><font color="#7c7c5f"><font face="Trebuchet MS,Default Sans Serif,Arial,Verdana,Helvetica,sans-serif" size="2"><span style="font-size:1em"><font color="#000080">Linette J. Williams</font></span></font></font></div><div style="font-size:10pt;font-weight:bold;font-family:sans-serif"><strong><span style="font-family:'trebuchet ms',helvetica,sans-serif"><font color="#696969"><span style="font-size:0.786em">Content experience | design | development </span></font></span></strong></div>

<div><strong><span style="font-family:'trebuchet ms',helvetica,sans-serif"><span style="font-size:0.786em"><font color="#696969"><br>IBM Cloud - COE Open Source<br></font></span></span></strong></div><span style="font-family:'trebuchet ms',helvetica,sans-serif"><span style="font-size:0.786em"><font color="#696969"><span style="font-weight:bold">E-mail: </span></font><a href="mailto:stemke@us.ibm.com" target="_blank"><font color="#555555"><font color="#696969">stemke@us.ibm.com</font></font></a></span></span></div></div></span></font><br>

<br>_______________________________________________<br>OpenStack-docs mailing list<br><a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br><br></blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div></div></div></div></div></font><BR>