<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head>
<body text="#000000" bgcolor="#FFFFFF">
<p>Amy,</p>
<p>The top level page for projects is referenced under documentation
from here: <a class="moz-txt-link-freetext" href="https://docs.openstack.org/queens/projects.html">https://docs.openstack.org/queens/projects.html</a></p>
<p>So, I think we have that one covered for people who are just
looking for the top level documentation.</p>
<p>Jay<br>
</p>
<br>
<div class="moz-cite-prefix">On 3/13/2018 3:02 PM, Amy Marrich
wrote:<br>
</div>
<blockquote type="cite"
cite="mid:CAFs83QrQ21-Y7p7O3BnDTHWPQ56jdUiwa4JDhTBQqJoYOVKniA@mail.gmail.com">
<div dir="ltr">I think if we're going to have that go to the
development contributors section (which makes sense) maybe we
should also have ways of getting to the deployment and admin
docs as well?
<div><br>
</div>
<div>Amy (spotz)</div>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">On Tue, Mar 13, 2018 at 2:55 PM, Jay S
Bryant <span dir="ltr"><<a
href="mailto:jungleboyj@gmail.com" target="_blank"
moz-do-not-send="true">jungleboyj@gmail.com</a>></span>
wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="HOEnZb">
<div class="h5"><br>
<br>
On 3/13/2018 1:38 PM, Petr Kovar wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
On Thu, 8 Mar 2018 12:54:06 -0600<br>
Jay S Bryant <<a href="mailto:jungleboyj@gmail.com"
target="_blank" moz-do-not-send="true">jungleboyj@gmail.com</a>>
wrote:<br>
<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
Good overview. Thank you!<br>
<br>
One additional goal I want to mention on the list,
for awareness, is the<br>
fact that we would like to eventually get some
consistency to the pages<br>
that the 'Contributor Guide' lands on for each of
the projects. Needs<br>
to be a page that is friendly to new contributors,
makes it easy to<br>
learn about the project and is not overwhelming.<br>
<br>
What exactly that looks like isn't defined yet but I
have talked to<br>
Manila about this. They were interested in working
together on this.<br>
Cinder and Manila will work together to get
something consistent put<br>
together and then we can work on spreading that to
other projects once<br>
we have agreement from the SIG that the approach is
agreeable.<br>
</blockquote>
This is a good cross-project goal, I think. We
discussed a similar approach<br>
in the docs room wrt providing templates to project
teams that they can<br>
use to design their landing pages for admin, user,
configuration docs; that<br>
would also include the main index page for project
docs.<br>
<br>
As for the project-specific contributor guides,<br>
<a
href="https://docs.openstack.org/doc-contrib-guide/project-guides.html"
rel="noreferrer" target="_blank"
moz-do-not-send="true">https://docs.openstack.org/doc<wbr>-contrib-guide/project-guides.<wbr>html</a>
specifies<br>
that any contributor content should go to
doc/source/contributor/. This will<br>
allow us to use templates to generate lists of links,
similarly to what<br>
we do for other content areas.<br>
<br>
Cheers,<br>
pk<br>
<br>
<br>
______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage
questions)<br>
Unsubscribe: <a
href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe"
rel="noreferrer" target="_blank"
moz-do-not-send="true">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
<a
href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev"
rel="noreferrer" target="_blank"
moz-do-not-send="true">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
</blockquote>
</div>
</div>
Petr,<br>
<br>
Good point. I was trying to think of how to make a better
landing page for new contributors and you may have hit on
the answer. RIght now when you click through from here: <a
href="https://www.openstack.org/community"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://www.openstack.org/comm<wbr>unity</a>
You land at the top level Cinder documentation page which is
incredibly overwhelming for a new person: <a
href="https://docs.openstack.org/cinder/latest/"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://docs.openstack.org/cin<wbr>der/latest/</a><br>
<br>
If the new contributor page instead lands here: <a
href="https://docs.openstack.org/cinder/latest/contributor/index.html"
rel="noreferrer" target="_blank" moz-do-not-send="true">https://docs.openstack.org/cin<wbr>der/latest/contributor/index.<wbr>html</a>
It would give me a page to craft for new users looking for
information to get started.<br>
<br>
Thoughts on this approach?<br>
<br>
Kendall and Mike ... Does the above approach make sense?<span
class="HOEnZb"><font color="#888888"><br>
<br>
Jay</font></span>
<div class="HOEnZb">
<div class="h5"><br>
<br>
<br>
______________________________<wbr>______________________________<wbr>______________<br>
OpenStack Development Mailing List (not for usage
questions)<br>
Unsubscribe: <a
href="http://OpenStack-dev-request@lists.openstack.org?subject:unsubscribe"
rel="noreferrer" target="_blank"
moz-do-not-send="true">OpenStack-dev-request@lists.op<wbr>enstack.org?subject:unsubscrib<wbr>e</a><br>
<a
href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev"
rel="noreferrer" target="_blank"
moz-do-not-send="true">http://lists.openstack.org/cgi<wbr>-bin/mailman/listinfo/openstac<wbr>k-dev</a><br>
</div>
</div>
</blockquote>
</div>
<br>
</div>
</blockquote>
<br>
</body>
</html>