Re: [openstack-dev] [nova] [docs] Ideal landing page
On 08/07/2017 06:58 PM, Doug Hellmann wrote: > Excerpts from Sean Dague's message of 2017-08-07 17:07:37 -0400: >> The integration of all the manual docs, plus all of our native docs >> trying to get restructured a bit, has left us with a first order mess >> when it comes to our front page (and the Table of Contents in the >> sidebar) - https://docs.openstack.org/nova/latest/ >> >> I started trying to pull things out of the sidebar TOC by creating some >> interior landing pages for Contributors and a Deep Dive Technical >> Reference. In staring at what was left on the page for a good hour today >> I came up with the following ideal front page outline. >> >> https://etherpad.openstack.org/p/ideal-nova-docs-landing-page >> >> This probably turns into 3 additional patches on topic:bp/doc-migration >> * For Users >> * For Operators >> * Index page smooth over >> >> The original docs spec didn't really separate out users / operators as >> target audiences. None of this will involve moving subpages around (so > > End-user content goes in /user. Operator content goes in /admin. See > http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html#proposed-change > for details. Ok, I guess a lot of things got binned incorrectly during the transition. I think the definition of user was less clearly understood. But it's fine, we can collect things together in subpages however works. -Sean -- Sean Dague http://dague.net __ 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
Re: [openstack-dev] [nova] [docs] Ideal landing page
Excerpts from Sean Dague's message of 2017-08-07 17:07:37 -0400: > The integration of all the manual docs, plus all of our native docs > trying to get restructured a bit, has left us with a first order mess > when it comes to our front page (and the Table of Contents in the > sidebar) - https://docs.openstack.org/nova/latest/ > > I started trying to pull things out of the sidebar TOC by creating some > interior landing pages for Contributors and a Deep Dive Technical > Reference. In staring at what was left on the page for a good hour today > I came up with the following ideal front page outline. > > https://etherpad.openstack.org/p/ideal-nova-docs-landing-page > > This probably turns into 3 additional patches on topic:bp/doc-migration > * For Users > * For Operators > * Index page smooth over > > The original docs spec didn't really separate out users / operators as > target audiences. None of this will involve moving subpages around (so End-user content goes in /user. Operator content goes in /admin. See http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html#proposed-change for details. > no additional redirects), it will just be a couple of sections and > landing documents where appropriate. > > Please chime in if you have opinions. Otherwise I'm going to start > writing the rest of this tomorrow to try to get it all sorted for RC. > > -Sean > __ 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
[openstack-dev] [nova] [docs] Ideal landing page
The integration of all the manual docs, plus all of our native docs trying to get restructured a bit, has left us with a first order mess when it comes to our front page (and the Table of Contents in the sidebar) - https://docs.openstack.org/nova/latest/ I started trying to pull things out of the sidebar TOC by creating some interior landing pages for Contributors and a Deep Dive Technical Reference. In staring at what was left on the page for a good hour today I came up with the following ideal front page outline. https://etherpad.openstack.org/p/ideal-nova-docs-landing-page This probably turns into 3 additional patches on topic:bp/doc-migration * For Users * For Operators * Index page smooth over The original docs spec didn't really separate out users / operators as target audiences. None of this will involve moving subpages around (so no additional redirects), it will just be a couple of sections and landing documents where appropriate. Please chime in if you have opinions. Otherwise I'm going to start writing the rest of this tomorrow to try to get it all sorted for RC. -Sean -- Sean Dague http://dague.net __ 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
