[Printing-architecture] OpenPrinting - Documentation urgently needed!
Till Kamppeter <[email protected]> Sun, 20 Aug 2023 20:02:18 +0200
| Newsgroups | dev.linux.lists.printing-architecture |
|---|---|
| Message-ID | <[email protected]> |
Hi,
now, with good parts of the New Architecture of printing and scanning
done, we see a lot of new code but we are really lacking documentation
for our software.
We already had some discussion about documentation, different types,
ways of obtaining, ... on the OpenPrinting micro-conference on the Linux
Plumbers 2022:
Slides:
https://lpc.events/event/16/contributions/1160/attachments/943/1853/lpc-printing-docs-2022.pdf
https://lpc.events/event/16/contributions/1160/attachments/943/1860/documentation-openprinting-extra.pdf
Recording:
https://www.youtube.com/watch?v=XoNydHus4VU
Now I would like to find some people who could help us in writing
documentation, making drawings and graphics, ... Therefore I am posting
this mail on the OpenPrinting mailing list but also direct it to people
who already have done documentation for OpenPrinting, spoke up that they
would like to volunteer on documentation, have contributed drawings and
graphics (or have done nice one in their projects) ...
What we need is documentation for:
- Developers: Library functions of libcupsfilters, libppd,
libpappl-retrofit, cpdb-libs, ... Documentation for individual
functions and data strutures is put right into the source code, tools
like Michael Sweet's codedoc generate the actual documentation from
that. Requires knowledge about coding.
- Admins: How to configure and set up things in networks
- Users: Easy steps to get printing just work.
Documentation will be posted on our web site but also included in source
packages.
We need reference manuals, man pages, HOWTOs, tutorials, also teaching
things in YouTube videos is welcome ...
So everyone who likes to contribute something is welcome to do so!
Please speak up here and tell what you like to contribute.
I will also run an OpenPrinting Roadmap Sprint on Sep 8, in the IIT
Mandi in Northern India, on the Opportunity Open Source which I am
organizing there.
https://events.canonical.com/event/35/
Depending on your answers and suggestions here I will do a session about
documentation. You could connect by video to it and participate, or if
you are near Mandi, come in person.
Let us not only have great printing and scanning but also great
documentation for it!
Till