[PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst

Peter Krempa posted 3 patches 3 years, 8 months ago
Failed in applying to current master (apply log)
docs/kbase.html.in       |  54 --------------
docs/kbase.rst           |  46 ++++++++++++
docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
docs/kbase/meson.build   |   1 +
docs/libvirt.css         |   8 +++
docs/meson.build         |   2 +-
6 files changed, 204 insertions(+), 55 deletions(-)
delete mode 100644 docs/kbase.html.in
create mode 100644 docs/kbase.rst
create mode 100644 docs/kbase/debuglogs.rst
[PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Peter Krempa 3 years, 8 months ago
This patchset:

1) converts the 'kbase' directory page to RST

2) increases width of the container holding the kbase articles:

before:
    https://libvirt.org/kbase.html

after:
    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase.html

3) ports 'debuglogs' wiki article to the kbase:

original:
    https://wiki.libvirt.org/page/DebugLogs
converted:
    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase/debuglogs.html

Note that this patchset requires Pavel's meson rewrite.

Peter Krempa (3):
  docs: kbase: Convert 'kbase' article registry to RST
  docs: kbase: Make kbase article directory wider
  docs: kbase: Port 'debuglogs' document from libvirt's wiki

 docs/kbase.html.in       |  54 --------------
 docs/kbase.rst           |  46 ++++++++++++
 docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
 docs/kbase/meson.build   |   1 +
 docs/libvirt.css         |   8 +++
 docs/meson.build         |   2 +-
 6 files changed, 204 insertions(+), 55 deletions(-)
 delete mode 100644 docs/kbase.html.in
 create mode 100644 docs/kbase.rst
 create mode 100644 docs/kbase/debuglogs.rst

-- 
2.26.2

Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Michal Privoznik 3 years, 8 months ago
On 7/30/20 12:30 PM, Peter Krempa wrote:
> This patchset:
> 
> 1) converts the 'kbase' directory page to RST
> 
> 2) increases width of the container holding the kbase articles:
> 
> before:
>      https://libvirt.org/kbase.html
> 
> after:
>      https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase.html
> 
> 3) ports 'debuglogs' wiki article to the kbase:
> 
> original:
>      https://wiki.libvirt.org/page/DebugLogs
> converted:
>      https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase/debuglogs.html
> 
> Note that this patchset requires Pavel's meson rewrite.
> 
> Peter Krempa (3):
>    docs: kbase: Convert 'kbase' article registry to RST
>    docs: kbase: Make kbase article directory wider
>    docs: kbase: Port 'debuglogs' document from libvirt's wiki
> 
>   docs/kbase.html.in       |  54 --------------
>   docs/kbase.rst           |  46 ++++++++++++
>   docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
>   docs/kbase/meson.build   |   1 +
>   docs/libvirt.css         |   8 +++
>   docs/meson.build         |   2 +-
>   6 files changed, 204 insertions(+), 55 deletions(-)
>   delete mode 100644 docs/kbase.html.in
>   create mode 100644 docs/kbase.rst
>   create mode 100644 docs/kbase/debuglogs.rst
> 

Reviewed-by: Michal Privoznik <mprivozn@redhat.com>

Michal

Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Ján Tomko 3 years, 7 months ago
On a Thursday in 2020, Peter Krempa wrote:
>This patchset:
>
>1) converts the 'kbase' directory page to RST
>
>2) increases width of the container holding the kbase articles:
>
>before:
>    https://libvirt.org/kbase.html
>
>after:
>    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase.html
>
>3) ports 'debuglogs' wiki article to the kbase:
>
>original:
>    https://wiki.libvirt.org/page/DebugLogs
>converted:
>    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase/debuglogs.html
>
>Note that this patchset requires Pavel's meson rewrite.
>
>Peter Krempa (3):
>  docs: kbase: Convert 'kbase' article registry to RST
>  docs: kbase: Make kbase article directory wider

Any ideas on how to make the 'Contents' section look nicer?
Namely:
  * 'Contents' feels like the equivalent of // THIS IS BRIDGE [0]
  * the spacing between the ToC and the first headline is too small
    for my taste

>  docs: kbase: Port 'debuglogs' document from libvirt's wiki
> docs/kbase.html.in       |  54 --------------
> docs/kbase.rst           |  46 ++++++++++++
> docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
> docs/kbase/meson.build   |   1 +
> docs/libvirt.css         |   8 +++
> docs/meson.build         |   2 +-
> 6 files changed, 204 insertions(+), 55 deletions(-)
> delete mode 100644 docs/kbase.html.in
> create mode 100644 docs/kbase.rst
> create mode 100644 docs/kbase/debuglogs.rst
>

Thank you.

Reviewed-by: Ján Tomko <jtomko@redhat.com>

Jano


[0] https://www.abstrusegoose.com/432
Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Peter Krempa 3 years, 7 months ago
On Sun, Aug 02, 2020 at 13:46:51 +0200, Ján Tomko wrote:
> On a Thursday in 2020, Peter Krempa wrote:
> > This patchset:
> > 
> > 1) converts the 'kbase' directory page to RST
> > 
> > 2) increases width of the container holding the kbase articles:
> > 
> > before:
> >    https://libvirt.org/kbase.html
> > 
> > after:
> >    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase.html
> > 
> > 3) ports 'debuglogs' wiki article to the kbase:
> > 
> > original:
> >    https://wiki.libvirt.org/page/DebugLogs
> > converted:
> >    https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kbase/debuglogs.html
> > 
> > Note that this patchset requires Pavel's meson rewrite.
> > 
> > Peter Krempa (3):
> >  docs: kbase: Convert 'kbase' article registry to RST
> >  docs: kbase: Make kbase article directory wider
> 
> Any ideas on how to make the 'Contents' section look nicer?
> Namely:
>  * 'Contents' feels like the equivalent of // THIS IS BRIDGE [0]

https://www.redhat.com/archives/libvir-list/2020-August/msg00063.html

>  * the spacing between the ToC and the first headline is too small
>    for my taste

https://www.redhat.com/archives/libvir-list/2020-August/msg00062.html
or
https://www.redhat.com/archives/libvir-list/2020-August/msg00064.html

Refer to the cover letter for links to rendered pages:

https://www.redhat.com/archives/libvir-list/2020-August/msg00059.html

Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Andrea Bolognani 3 years, 4 months ago
On Thu, 2020-07-30 at 12:30 +0200, Peter Krempa wrote:
> Peter Krempa (3):
>   docs: kbase: Convert 'kbase' article registry to RST
>   docs: kbase: Make kbase article directory wider
>   docs: kbase: Port 'debuglogs' document from libvirt's wiki

I just realized that, despite this series having been merged for a
long time, the original wiki page[1] still exists and its contents
are the same as they were back in July.

Can someone with write access to the wiki please turn it into a short
stub that points people to the kbase article[2] instead?

Thanks!


[1] https://wiki.libvirt.org/page/DebugLogs
[2] https://libvirt.org/kbase/debuglogs.html
-- 
Andrea Bolognani / Red Hat / Virtualization

Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Ján Tomko 3 years, 4 months ago
On a Friday in 2020, Andrea Bolognani wrote:
>On Thu, 2020-07-30 at 12:30 +0200, Peter Krempa wrote:
>> Peter Krempa (3):
>>   docs: kbase: Convert 'kbase' article registry to RST
>>   docs: kbase: Make kbase article directory wider
>>   docs: kbase: Port 'debuglogs' document from libvirt's wiki
>
>I just realized that, despite this series having been merged for a
>long time, the original wiki page[1] still exists and its contents
>are the same as they were back in July.
>
>Can someone with write access to the wiki please turn it into a short
>stub that points people to the kbase article[2] instead?
>

Done. Hope it's short enough for your taste.

Jano

>Thanks!
>
>
>[1] https://wiki.libvirt.org/page/DebugLogs
>[2] https://libvirt.org/kbase/debuglogs.html
>-- 
>Andrea Bolognani / Red Hat / Virtualization
>
Re: [PATCH 0/3] kbase: Port 'debuglogs' from wiki and convert directory to rst
Posted by Andrea Bolognani 3 years, 4 months ago
On Fri, 2020-11-13 at 15:14 +0100, Ján Tomko wrote:
> On a Friday in 2020, Andrea Bolognani wrote:
> > Can someone with write access to the wiki please turn it into a short
> > stub that points people to the kbase article[2] instead?
> 
> Done. Hope it's short enough for your taste.

It definitely does the trick :) Thank you!

-- 
Andrea Bolognani / Red Hat / Virtualization