[all] Removing privacy breaches in doc

Sean McGinnis sean.mcginnis at gmx.com
Mon Apr 8 18:13:37 UTC 2019

> > >
> > > The rendering on PyPi, and the validation that they do that will reject the
> > > package upload if it has README syntax errors, is not aware of any Sphinx
> > > extensions we use in our normal docs, so pulling in other documentation into
> > > the README could potentially cause release issues.
> >
> > Good point. Maybe we should just stop including README content in sphinx
> > docs, and not do anything additional that's more complex?
> >
> Honestly, this means copy-paste and that one of the copies will probably get
> outdated.

What is in the README that is needed in the documentation? For me, those have
always been entirely different audiences and therefore different content.

Maybe it just needs a different perspective for these project from how they've
used them so far?

More information about the openstack-discuss mailing list