[PATCH v2 0/6] rSTify contribution-related wiki pages

Kashyap Chamarthy posted 6 patches 2 years, 6 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20211019090344.3054300-1-kchamart@redhat.com
Maintainers: Michael Tokarev <mjt@tls.msk.ru>, Laurent Vivier <laurent@vivier.eu>
There is a newer version of this series
docs/devel/index.rst                     |   5 +
docs/devel/key-signing-party.rst         | 171 +++++++++
docs/devel/spell-check.rst               |  20 +
docs/devel/submitting-a-patch.rst        | 460 +++++++++++++++++++++++
docs/devel/submitting-a-pull-request.rst |  79 ++++
docs/devel/trivial-patches.rst           |  51 +++
6 files changed, 786 insertions(+)
create mode 100644 docs/devel/key-signing-party.rst
create mode 100644 docs/devel/spell-check.rst
create mode 100644 docs/devel/submitting-a-patch.rst
create mode 100644 docs/devel/submitting-a-pull-request.rst
create mode 100644 docs/devel/trivial-patches.rst
[PATCH v2 0/6] rSTify contribution-related wiki pages
Posted by Kashyap Chamarthy 2 years, 6 months ago
My main motivation was to convert SubmitAPatch[1] based on a chat with
Peter Maydell and Dan Berrangé on #qemu channel (on OFTC).  But the page
also links to a couple of other contribution-related pages, so I
converted them too:

  - SubmitAPullRequest: https://wiki.qemu.org/Contribute/SubmitAPullRequest
  - KeySigningParty: https://wiki.qemu.org/KeySigningParty
  - SpellCheck: https://wiki.qemu.org/Contribute/SpellCheck
  - TrivialPatches: https://wiki.qemu.org/Contribute/TrivialPatches

[1] https://wiki.qemu.org/Contribute/SubmitAPatch

                * * *

Changes in v2:

- Consistently use the preferred rST headings: ===, ---, and ~~~~
  [Paolo]
- Add entries in the devel/toctree.rst [Paolo]
- Clean up the SpellCheck wiki [Peter Maydell]
- In trivial-patches.rst, keep only Laurent as the active maintainer
  [Philippe]
- Convert the wiki SubmitAPullRequest to rST, because this is also
  linked to from the SubmitAPatch wiki page
- Convert the KeySigningParty wiki to rST
- Update the links to point to the rST-generated HTML files, instead of
  wiki

Kashyap Chamarthy (6):
  docs: rSTify the "TrivialPatches" wiki
  docs: rSTify the "SpellCheck" wiki
  docs: rSTify the "KeySigningParty" wiki
  docs: rSTify the "SubmitAPullRequest" wiki
  docs: rSTify the "SubmitAPatch" wiki
  docs/devel: Update the rST index file

 docs/devel/index.rst                     |   5 +
 docs/devel/key-signing-party.rst         | 171 +++++++++
 docs/devel/spell-check.rst               |  20 +
 docs/devel/submitting-a-patch.rst        | 460 +++++++++++++++++++++++
 docs/devel/submitting-a-pull-request.rst |  79 ++++
 docs/devel/trivial-patches.rst           |  51 +++
 6 files changed, 786 insertions(+)
 create mode 100644 docs/devel/key-signing-party.rst
 create mode 100644 docs/devel/spell-check.rst
 create mode 100644 docs/devel/submitting-a-patch.rst
 create mode 100644 docs/devel/submitting-a-pull-request.rst
 create mode 100644 docs/devel/trivial-patches.rst

-- 
2.31.1



Re: [PATCH v2 0/6] rSTify contribution-related wiki pages
Posted by Kashyap Chamarthy 2 years, 6 months ago
On Tue, Oct 19, 2021 at 11:03:38AM +0200, Kashyap Chamarthy wrote:
> My main motivation was to convert SubmitAPatch[1] based on a chat with
> Peter Maydell and Dan Berrangé on #qemu channel (on OFTC).  But the page
> also links to a couple of other contribution-related pages, so I
> converted them too:
> 
>   - SubmitAPullRequest: https://wiki.qemu.org/Contribute/SubmitAPullRequest
>   - KeySigningParty: https://wiki.qemu.org/KeySigningParty
>   - SpellCheck: https://wiki.qemu.org/Contribute/SpellCheck
>   - TrivialPatches: https://wiki.qemu.org/Contribute/TrivialPatches
> 
> [1] https://wiki.qemu.org/Contribute/SubmitAPatch
> 
>                 * * *

Sorry; forgot to link to v1, it's here:

    https://lists.nongnu.org/archive/html/qemu-devel/2021-09/msg05604.html
    [PATCH 0/3] rSTify SubmitAPatch, TrivialPatches, and SpellCheck wiki
    pages

> Changes in v2:
> 
> - Consistently use the preferred rST headings: ===, ---, and ~~~~
>   [Paolo]
> - Add entries in the devel/toctree.rst [Paolo]
> - Clean up the SpellCheck wiki [Peter Maydell]
> - In trivial-patches.rst, keep only Laurent as the active maintainer
>   [Philippe]
> - Convert the wiki SubmitAPullRequest to rST, because this is also
>   linked to from the SubmitAPatch wiki page
> - Convert the KeySigningParty wiki to rST
> - Update the links to point to the rST-generated HTML files, instead of
>   wiki
> 
> Kashyap Chamarthy (6):
>   docs: rSTify the "TrivialPatches" wiki
>   docs: rSTify the "SpellCheck" wiki
>   docs: rSTify the "KeySigningParty" wiki
>   docs: rSTify the "SubmitAPullRequest" wiki
>   docs: rSTify the "SubmitAPatch" wiki
>   docs/devel: Update the rST index file
> 
>  docs/devel/index.rst                     |   5 +
>  docs/devel/key-signing-party.rst         | 171 +++++++++
>  docs/devel/spell-check.rst               |  20 +
>  docs/devel/submitting-a-patch.rst        | 460 +++++++++++++++++++++++
>  docs/devel/submitting-a-pull-request.rst |  79 ++++
>  docs/devel/trivial-patches.rst           |  51 +++
>  6 files changed, 786 insertions(+)
>  create mode 100644 docs/devel/key-signing-party.rst
>  create mode 100644 docs/devel/spell-check.rst
>  create mode 100644 docs/devel/submitting-a-patch.rst
>  create mode 100644 docs/devel/submitting-a-pull-request.rst
>  create mode 100644 docs/devel/trivial-patches.rst
> 
> -- 
> 2.31.1
> 
> 

-- 
/kashyap


Re: [PATCH v2 0/6] rSTify contribution-related wiki pages
Posted by Peter Maydell 2 years, 6 months ago
On Tue, 19 Oct 2021 at 10:04, Kashyap Chamarthy <kchamart@redhat.com> wrote:
>
> My main motivation was to convert SubmitAPatch[1] based on a chat with
> Peter Maydell and Dan Berrangé on #qemu channel (on OFTC).  But the page
> also links to a couple of other contribution-related pages, so I
> converted them too:
>
>   - SubmitAPullRequest: https://wiki.qemu.org/Contribute/SubmitAPullRequest
>   - KeySigningParty: https://wiki.qemu.org/KeySigningParty
>   - SpellCheck: https://wiki.qemu.org/Contribute/SpellCheck
>   - TrivialPatches: https://wiki.qemu.org/Contribute/TrivialPatches

I'm not sure that SpellCheck in particular is sufficiently baked
to be in the actual docs. I'd rather just drop the reference to it
from SubmitAPatch. KeySigningParty I'm on the fence about.

-- PMM