On 3/13/2018 1:38 PM, Petr Kovar wrote:
On Thu, 8 Mar 2018 12:54:06 -0600
Jay S Bryant <[email protected]> wrote:
Good overview. Thank you!
One additional goal I want to mention on the list, for awareness, is the
fact that we would like to eventually get some consistency to the pages
that the 'Contributor Guide' lands on for each of the projects. Needs
to be a page that is friendly to new contributors, makes it easy to
learn about the project and is not overwhelming.
What exactly that looks like isn't defined yet but I have talked to
Manila about this. They were interested in working together on this.
Cinder and Manila will work together to get something consistent put
together and then we can work on spreading that to other projects once
we have agreement from the SIG that the approach is agreeable.
This is a good cross-project goal, I think. We discussed a similar approach
in the docs room wrt providing templates to project teams that they can
use to design their landing pages for admin, user, configuration docs; that
would also include the main index page for project docs.
As for the project-specific contributor guides,
https://docs.openstack.org/doc-contrib-guide/project-guides.html specifies
that any contributor content should go to doc/source/contributor/. This will
allow us to use templates to generate lists of links, similarly to what
we do for other content areas.
Cheers,
pk
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [email protected]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Petr,
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: https://www.openstack.org/community You
land at the top level Cinder documentation page which is incredibly
overwhelming for a new person: https://docs.openstack.org/cinder/latest/
If the new contributor page instead lands here:
https://docs.openstack.org/cinder/latest/contributor/index.html It would
give me a page to craft for new users looking for information to get
started.
Thoughts on this approach?
Kendall and Mike ... Does the above approach make sense?
Jay
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [email protected]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
