On Sat, 2023-09-02 at 08:13 +0100, Richard Purdie via lists.openembedded.org wrote: > We've needed a way to queue/note/sync docs changes with our manuals, migration > guides and release notes. Add a file which we can use to "stage" information. > We can then ask users submitting changes which need docs changes to add > information here. This will then make it easier for the docs to be brought > into sync as we'll have a much better idea of when something merged and > what changes are needed. > > Signed-off-by: Richard Purdie <[email protected]> > --- > DOCS-WIP | 4 ++++ > 1 file changed, 4 insertions(+) > create mode 100644 DOCS-WIP > > diff --git a/DOCS-WIP b/DOCS-WIP > new file mode 100644 > index 00000000000..0e2baf9e0bf > --- /dev/null > +++ b/DOCS-WIP > @@ -0,0 +1,4 @@ > +This file is intended to note docs changes that are being made by commits so > +that people working on the documentation know that changes are needed. This > +includes entries that would make sense for the migration guide or release > notes. > +
This has proven contentious. Whilst I think it would help our docs maintenance, there are differing views: * it should be a directory for conflict reasons * we don't want a top level directory for this * we don't want a directory called "WIP" as it looks bad * we shouldn't have "partial" half way staging, either the docs are in repo or they're not I'm weary, I can't reconcile the views being expressed, some people haven't clearly haven't read or understood the proposal reasoning and its turning into a perfect bike shedding exercise. Much as I think it would be the right direction, some people won't be happy, the complaints are going to annoy me and I'm going to abandon the patch. Richard
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#187252): https://lists.openembedded.org/g/openembedded-core/message/187252 Mute This Topic: https://lists.openembedded.org/mt/101109943/21656 Group Owner: [email protected] Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub [[email protected]] -=-=-=-=-=-=-=-=-=-=-=-
