On Wed, 14 Mar 2018 10:38:37 -0500 Jay S Bryant <jungleb...@gmail.com> wrote:
> > > On 3/14/2018 10:04 AM, Petr Kovar wrote: > > On Tue, 13 Mar 2018 18:57:24 -0500 > > Jay S Bryant <jungleb...@gmail.com> wrote: > > > >> Amy, > >> > >> The top level page for projects is referenced under documentation from > >> here: https://docs.openstack.org/queens/projects.html > >> > >> So, I think we have that one covered for people who are just looking for > >> the top level documentation. > > Yes, we have that covered. Just to clarify this a bit further, we also have > > project lists like https://docs.openstack.org/queens/install/, > > https://docs.openstack.org/queens/admin/ and > > https://docs.openstack.org/queens/configuration/, what's missing is > > https://docs.openstack.org/queens/contributor/. > > > > Cheers, > > pk > > > Petr, > > Do we need a contributor link per-release? I thought in past > discussions that the contributor info should always go to latest and > that was why this is slightly different. Right, that's a good point! I guess we should really just have https://docs.openstack.org/latest/contributor/ then, perhaps https://docs.openstack.org/contributor/ would be even better (with a redirect). This means we need to treat templates for contributor project docs as a special case and just point to /latest/contributor from all release-specific docs.o.o landing pages. Cheers, pk > >> On 3/13/2018 3:02 PM, Amy Marrich wrote: > >>> 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? > >>> > >>> Amy (spotz) > >>> > >>> On Tue, Mar 13, 2018 at 2:55 PM, Jay S Bryant <jungleb...@gmail.com > >>> <mailto:jungleb...@gmail.com>> wrote: > >>> > >>> > >>> > >>> On 3/13/2018 1:38 PM, Petr Kovar wrote: > >>> > >>> On Thu, 8 Mar 2018 12:54:06 -0600 > >>> Jay S Bryant <jungleb...@gmail.com > >>> <mailto:jungleb...@gmail.com>> 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 > >>> > >>> <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: > >>> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > >>> > >>> <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > >>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > >>> > >>> <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 > >>> <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/ > >>> <https://docs.openstack.org/cinder/latest/> > >>> > >>> If the new contributor page instead lands here: > >>> https://docs.openstack.org/cinder/latest/contributor/index.html > >>> <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: > >>> openstack-dev-requ...@lists.openstack.org?subject:unsubscribe > >>> > >>> <http://openstack-dev-requ...@lists.openstack.org?subject:unsubscribe> > >>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev > >>> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev> > >>> > >>> > > > -- Petr Kovar Sr. Technical Writer | Customer Content Services Red Hat Czech, Brno __________________________________________________________________________ OpenStack Development Mailing List (not for usage questions) Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev