| Message ID | 20220314104943.513593-3-kchamart@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | rSTify a few more docs; move them to QEMU Git | expand |
Hi Kashyap, On 14/3/22 11:49, Kashyap Chamarthy wrote: > This document is referred to from the GettingStartedDevelopers wiki > which will be rSTified in a follow-up commit. > > Converted from Mediawiki to rST using: > > $> pandoc -f Mediawiki -t rst MailingLists.wiki > -o mailing-lists.rst > > It's a 1-1 conversion (I double-checked to the best I could). I've also > checked that the hyperlinks work correctly post-conversion. > > Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com> > --- > docs/devel/index.rst | 1 + > docs/devel/mailing-lists.rst | 53 ++++++++++++++++++++++++++++++++++++ > 2 files changed, 54 insertions(+) > create mode 100644 docs/devel/mailing-lists.rst > diff --git a/docs/devel/mailing-lists.rst b/docs/devel/mailing-lists.rst > new file mode 100644 > index 0000000000..53dcbfb007 > --- /dev/null > +++ b/docs/devel/mailing-lists.rst > @@ -0,0 +1,53 @@ > +.. _mailing-lists: > + > +Mailing lists > +============= > + > +- `QEMU developers mailing > + list <http://lists.nongnu.org/mailman/listinfo/qemu-devel>`__ > +- `QEMU stable mailing > + list <http://lists.nongnu.org/mailman/listinfo/qemu-stable>`__ > +- `QEMU trivial patch mailing > + list <http://lists.nongnu.org/mailman/listinfo/qemu-trivial>`__ > +- `QEMU users mailing > + list <http://lists.nongnu.org/mailman/listinfo/qemu-discuss>`__ This is a fair conversion from https://wiki.qemu.org/Contribute/MailingLists, but a good opportunity to improve (could be on top). We could sort as: * qemu-discuss Meant for users. Ideally help should point at Documentation link, and in case of missing doc we should add it or at least a GitLab @Documentation ticket. * qemu-devel Meant for developers. "All patches must be sent there". Then developer sub-lists: - qemu-trivial - qemu-stable (this is kinda borderline, security issue fixes should Cc this list, however it has to be treated as a write-only list - a way to tag patches - no discussion happens there). - susbsystem specific > block layer > architecture specific . ARM . PPC . ... > +.. _subsystem_specific_lists: > + > +Subsystem Specific Lists > +------------------------ > + > +These exist to make it a little easier to follow subsystem specific > +patches. You should however continue to CC qemu-devel so your series > +gets wide visibility. > + > +- `QEMU ARM mailing > + list <https://lists.nongnu.org/mailman/listinfo/qemu-arm>`__ > +- `QEMU block devices mailing > + list <https://lists.nongnu.org/mailman/listinfo/qemu-block>`__ > +- `QEMU PowerPC mailing > + list <https://lists.nongnu.org/mailman/listinfo/qemu-ppc>`__ > +- `QEMU RISC-V mailing > + list <https://lists.nongnu.org/mailman/listinfo/qemu-riscv>`__ > +- `QEMU s390x mailing > + list <https://lists.nongnu.org/mailman/listinfo/qemu-s390x>`__
On Mon, Mar 14, 2022 at 02:45:30PM +0100, Philippe Mathieu-Daudé wrote: > Hi Kashyap, Hi, > On 14/3/22 11:49, Kashyap Chamarthy wrote: [...] > This is a fair conversion from > https://wiki.qemu.org/Contribute/MailingLists, but a good opportunity to > improve (could be on top). Yeah, definitely. I'll make a TODO to add it on top. (I didn't wanted to mix in content edits with conversion changes, as it puts additional burden on the reviewers.) > We could sort as: > > * qemu-discuss > > Meant for users. Ideally help should point at Documentation link, > and in case of missing doc we should add it or at least a GitLab > @Documentation ticket. > > * qemu-devel > > Meant for developers. "All patches must be sent there". > > Then developer sub-lists: > > - qemu-trivial > > - qemu-stable (this is kinda borderline, security issue fixes should > Cc this list, however it has to be treated as a write-only list > - a way to tag patches - no discussion happens there). Nit: The term "kinda boderline" here can mean anything from "its purpose is questionable" to "it is used for unintended purposes", etc. Let's avoid vague phrasing in public-facing text. We can just be descriptive of what the purpose of the list is. :-) Thanks for the review! > - susbsystem specific > > > block layer > > > architecture specific > > . ARM > . PPC > . ... [...]
On 14/03/2022 11.49, Kashyap Chamarthy wrote: > This document is referred to from the GettingStartedDevelopers wiki > which will be rSTified in a follow-up commit. > > Converted from Mediawiki to rST using: > > $> pandoc -f Mediawiki -t rst MailingLists.wiki > -o mailing-lists.rst > > It's a 1-1 conversion (I double-checked to the best I could). I've also > checked that the hyperlinks work correctly post-conversion. > > Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com> > --- > docs/devel/index.rst | 1 + > docs/devel/mailing-lists.rst | 53 ++++++++++++++++++++++++++++++++++++ > 2 files changed, 54 insertions(+) > create mode 100644 docs/devel/mailing-lists.rst > > diff --git a/docs/devel/index.rst b/docs/devel/index.rst > index 424eff9294..fb9d9f3a80 100644 > --- a/docs/devel/index.rst > +++ b/docs/devel/index.rst > @@ -12,6 +12,7 @@ modifying QEMU's source code. > > code-of-conduct > conflict-resolution > + mailing-lists > build-system > style > kconfig > diff --git a/docs/devel/mailing-lists.rst b/docs/devel/mailing-lists.rst > new file mode 100644 > index 0000000000..53dcbfb007 > --- /dev/null > +++ b/docs/devel/mailing-lists.rst At least the "users" mailing list is not related to development, so maybe this should rather go into docs/about/ instead? Anyway: Reviewed-by: Thomas Huth <thuth@redhat.com>
On Tue, Mar 15, 2022 at 02:25:05PM +0100, Thomas Huth wrote: > On 14/03/2022 11.49, Kashyap Chamarthy wrote: [...] > At least the "users" mailing list is not related to development, so maybe > this should rather go into docs/about/ instead? Yeah, makes sense. I wonder if should create a new doc in docs/about/ for user-lists, as none of the existing docs fit the bill: build-platforms.rst deprecated.rst index.rst license.rst removed-features.rst > Anyway: > > Reviewed-by: Thomas Huth <thuth@redhat.com> Thank you. Related: I just sent the below patch to the list and Cced you (it hasn't yet appeared on the archives as of this writing): "docs/devel: Fix broken internal link to mailing lists" The above should be merged on top of the current patch[1] you've just reviewed. Otherwise Sphinx will complain (correctly so). [1] https://lists.nongnu.org/archive/html/qemu-devel/2022-03/msg03488.html -- docs: rSTify MailingLists wiki; move it to QEMU Git
On Tue, 15 Mar 2022 at 16:00, Kashyap Chamarthy <kchamart@redhat.com> wrote: > > On Tue, Mar 15, 2022 at 02:25:05PM +0100, Thomas Huth wrote: > > On 14/03/2022 11.49, Kashyap Chamarthy wrote: > > [...] > > > At least the "users" mailing list is not related to development, so maybe > > this should rather go into docs/about/ instead? > > Yeah, makes sense. I wonder if should create a new doc in docs/about/ > for user-lists, as none of the existing docs fit the bill: > > build-platforms.rst deprecated.rst index.rst license.rst > removed-features.rst Yes, I think that about/ should have a document something like "Contacting the project" or "Support", which could tell users about not just the user-facing mailing lists but also where to file bugs, and so on. In fact, it should probably look rather like the https://www.qemu.org/support/ page... -- PMM
On Tue, Mar 15, 2022 at 04:12:50PM +0000, Peter Maydell wrote: > On Tue, 15 Mar 2022 at 16:00, Kashyap Chamarthy <kchamart@redhat.com> wrote: > > > > On Tue, Mar 15, 2022 at 02:25:05PM +0100, Thomas Huth wrote: > > > On 14/03/2022 11.49, Kashyap Chamarthy wrote: > > > > [...] > > > > > At least the "users" mailing list is not related to development, so maybe > > > this should rather go into docs/about/ instead? > > > > Yeah, makes sense. I wonder if should create a new doc in docs/about/ > > for user-lists, as none of the existing docs fit the bill: > > > > build-platforms.rst deprecated.rst index.rst license.rst > > removed-features.rst > > Yes, I think that about/ should have a document something like > "Contacting the project" or "Support", which could tell users about not just > the user-facing mailing lists but also where to file bugs, and so on. > > In fact, it should probably look rather like the > https://www.qemu.org/support/ page... Heh, thanks, I missed that page. So, if I parsed you right, you're implying, given the above qemu-web page, there's no need for a separate about/support.rst doc.
On Mon, 21 Mar 2022 at 09:55, Kashyap Chamarthy <kchamart@redhat.com> wrote: > > On Tue, Mar 15, 2022 at 04:12:50PM +0000, Peter Maydell wrote: > > On Tue, 15 Mar 2022 at 16:00, Kashyap Chamarthy <kchamart@redhat.com> wrote: > > > > > > On Tue, Mar 15, 2022 at 02:25:05PM +0100, Thomas Huth wrote: > > > > On 14/03/2022 11.49, Kashyap Chamarthy wrote: > > > > > > [...] > > > > > > > At least the "users" mailing list is not related to development, so maybe > > > > this should rather go into docs/about/ instead? > > > > > > Yeah, makes sense. I wonder if should create a new doc in docs/about/ > > > for user-lists, as none of the existing docs fit the bill: > > > > > > build-platforms.rst deprecated.rst index.rst license.rst > > > removed-features.rst > > > > Yes, I think that about/ should have a document something like > > "Contacting the project" or "Support", which could tell users about not just > > the user-facing mailing lists but also where to file bugs, and so on. > > > > In fact, it should probably look rather like the > > https://www.qemu.org/support/ page... > > Heh, thanks, I missed that page. So, if I parsed you right, you're > implying, given the above qemu-web page, there's no need for a separate > about/support.rst doc. I think there is some merit in the documentation being standalone, even if it does mean a bit of duplication with the website. -- PMM
On Mon, Mar 21, 2022 at 11:01:28AM +0000, Peter Maydell wrote: > On Mon, 21 Mar 2022 at 09:55, Kashyap Chamarthy <kchamart@redhat.com> wrote: [...] > > > Yes, I think that about/ should have a document something like > > > "Contacting the project" or "Support", which could tell users about not just > > > the user-facing mailing lists but also where to file bugs, and so on. > > > > > > In fact, it should probably look rather like the > > > https://www.qemu.org/support/ page... > > > > Heh, thanks, I missed that page. So, if I parsed you right, you're > > implying, given the above qemu-web page, there's no need for a separate > > about/support.rst doc. > > I think there is some merit in the documentation being standalone, > even if it does mean a bit of duplication with the website. Yeah, fair point. I'll add an appropriate page as part of v2. Thanks for the quick feedback.
diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 424eff9294..fb9d9f3a80 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -12,6 +12,7 @@ modifying QEMU's source code. code-of-conduct conflict-resolution + mailing-lists build-system style kconfig diff --git a/docs/devel/mailing-lists.rst b/docs/devel/mailing-lists.rst new file mode 100644 index 0000000000..53dcbfb007 --- /dev/null +++ b/docs/devel/mailing-lists.rst @@ -0,0 +1,53 @@ +.. _mailing-lists: + +Mailing lists +============= + +- `QEMU developers mailing + list <http://lists.nongnu.org/mailman/listinfo/qemu-devel>`__ +- `QEMU stable mailing + list <http://lists.nongnu.org/mailman/listinfo/qemu-stable>`__ +- `QEMU trivial patch mailing + list <http://lists.nongnu.org/mailman/listinfo/qemu-trivial>`__ +- `QEMU users mailing + list <http://lists.nongnu.org/mailman/listinfo/qemu-discuss>`__ + +.. _subsystem_specific_lists: + +Subsystem Specific Lists +------------------------ + +These exist to make it a little easier to follow subsystem specific +patches. You should however continue to CC qemu-devel so your series +gets wide visibility. + +- `QEMU ARM mailing + list <https://lists.nongnu.org/mailman/listinfo/qemu-arm>`__ +- `QEMU block devices mailing + list <https://lists.nongnu.org/mailman/listinfo/qemu-block>`__ +- `QEMU PowerPC mailing + list <https://lists.nongnu.org/mailman/listinfo/qemu-ppc>`__ +- `QEMU RISC-V mailing + list <https://lists.nongnu.org/mailman/listinfo/qemu-riscv>`__ +- `QEMU s390x mailing + list <https://lists.nongnu.org/mailman/listinfo/qemu-s390x>`__ + +If a subsystem maintainer thinks that a new mailing list for their +subsystem would make life easier, we're happy to create one -- mail +qemu-devel to suggest it (ideally cc'ing the people listed as Savannah +project admins in our `AdminContacts <AdminContacts>`__ page, as they +are the ones with the ability to make the change). + +If you are a Savannah project admin, you may want the `technical notes +on how to create and configure a new +list <Contribute/MailingLists/Creation>`__. + +.. _access_via_lore.kernel.org: + +Access via lore.kernel.org +-------------------------- + +The qemu-devel mailing list is also archived via +`public-inbox <https://public-inbox.org/>`__ on +https://lore.kernel.org/qemu-devel/ and accessible via NNTP at +nntp.lore.kernel.org (newsgroup org.nongnu.qemu-devel).
This document is referred to from the GettingStartedDevelopers wiki which will be rSTified in a follow-up commit. Converted from Mediawiki to rST using: $> pandoc -f Mediawiki -t rst MailingLists.wiki -o mailing-lists.rst It's a 1-1 conversion (I double-checked to the best I could). I've also checked that the hyperlinks work correctly post-conversion. Signed-off-by: Kashyap Chamarthy <kchamart@redhat.com> --- docs/devel/index.rst | 1 + docs/devel/mailing-lists.rst | 53 ++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 docs/devel/mailing-lists.rst