[PATCH 00/11] doc: documentation revamp
Jani Nikula
jani.nikula at intel.com
Thu Oct 25 15:22:00 UTC 2018
The main goal here is to start arranging the docs by topic/function, and
then subdivide by drm-misc/drm-intel repo specific things. This will
make it easier to further unify the documentation for common
stuff.
Hopefully this will also make it easier for the different target
audiences of the documentation. Most people don't really care about the
maintainer documentation, so there's no point in mixing it up with
committer documentation. OTOH there's a lot of overlap in drm-misc and
drm-intel committers.
Start off with a bunch of overdue cleanups and clarifications.
Mostly this is just documentation movement and tweaks, but the drm-intel
branch maintainer guidelines is the biggest addition.
Finally, there's more to be done on the drm-misc.rst and drm-intel.rst
after this, but you gotta start somewhere, and this is where I ran out
of steam... ;)
BR,
Jani.
Jani Nikula (11):
gitignore: remove *.html from gitignore
doc: update CONTRIBUTING and add MAINTAINERS file
doc: don't reuse README for index.rst and project home page
doc: make COPYING rst and include it at the top level
doc: move commit rights criteria to shared doc
doc: consolidate code of conduct note to one place
doc: make adherence to CoC an explicit requirement for commit access
doc: add common committer guidelines file
doc: add common maintainer guidelines file, start with drm-intel
doc: move drm-misc committer guidelines
doc: move drm-misc maintainer guidelines
.gitignore | 1 -
CONTRIBUTING.rst | 20 +++-
COPYING => COPYING.rst | 6 +
MAINTAINERS.rst | 10 ++
README.rst | 21 ++--
code-of-conduct.rst | 23 ++++
commit-access.rst | 49 +++++---
committer-drm-intel.rst | 271 +++++++++++++++++++++++++++++++++++++++++++++
committer-drm-misc.rst | 101 +++++++++++++++++
committer-guidelines.rst | 13 +++
conf.py | 2 +-
drm-intel.rst | 276 +---------------------------------------------
drm-misc.rst | 187 -------------------------------
index.rst | 21 +++-
maintainer-drm-intel.rst | 141 +++++++++++++++++++++++
maintainer-drm-misc.rst | 51 +++++++++
maintainer-guidelines.rst | 13 +++
17 files changed, 710 insertions(+), 496 deletions(-)
rename COPYING => COPYING.rst (96%)
create mode 100644 MAINTAINERS.rst
create mode 100644 code-of-conduct.rst
create mode 100644 committer-drm-intel.rst
create mode 100644 committer-drm-misc.rst
create mode 100644 committer-guidelines.rst
create mode 100644 maintainer-drm-intel.rst
create mode 100644 maintainer-drm-misc.rst
create mode 100644 maintainer-guidelines.rst
--
2.11.0
More information about the dim-tools
mailing list