[v3] rSTify contribution-related wiki pages

[PATCH v3 0/3] rSTify contribution-related wiki pages

Posted by Kashyap Chamarthy 2 years, 5 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
  - TrivialPatches: https://wiki.qemu.org/Contribute/TrivialPatches

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

I built with `configure --target-list=x86_64-softmmu --enable-docs &&
make -j8`, and verified there isn't any breakage in the rendered docs.

                * * *
Changes in v3:

- Update index entry as part of each individual rST conversion patch
  [PeterM]
- Drop the SpellCheck rST [PeterM]
- Drop the KeySigning rST [ThomasH]
- Drop mjt's Git repo from trivial-patches.rst [LaurentV]

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 (3):
  docs: rSTify the "TrivialPatches" wiki
  docs: rSTify the "SubmitAPullRequest" wiki
  docs: rSTify the "SubmitAPatch" wiki

 docs/devel/index.rst                     |   3 +
 docs/devel/submitting-a-patch.rst        | 456 +++++++++++++++++++++++
 docs/devel/submitting-a-pull-request.rst |  76 ++++
 docs/devel/trivial-patches.rst           |  50 +++
 4 files changed, 585 insertions(+)
 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 v3 0/3] rSTify contribution-related wiki pages

Posted by Philippe Mathieu-Daudé 2 years, 5 months ago

On 11/10/21 15:48, 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
>   - TrivialPatches: https://wiki.qemu.org/Contribute/TrivialPatches
> 
> [1] https://wiki.qemu.org/Contribute/SubmitAPatch
> 
> I built with `configure --target-list=x86_64-softmmu --enable-docs &&
> make -j8`, and verified there isn't any breakage in the rendered docs.
> 
>                 * * *
> Changes in v3:
> 
> - Update index entry as part of each individual rST conversion patch
>   [PeterM]
> - Drop the SpellCheck rST [PeterM]
> - Drop the KeySigning rST [ThomasH]
> - Drop mjt's Git repo from trivial-patches.rst [LaurentV]
> 
> 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 (3):
>   docs: rSTify the "TrivialPatches" wiki
>   docs: rSTify the "SubmitAPullRequest" wiki
>   docs: rSTify the "SubmitAPatch" wiki

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>