[pve-devel] [PATCH docs 1/2] move footnote of Ceph's intro into TIP section

Alwin Antreich a.antreich at proxmox.com
Mon Oct 12 14:42:35 CEST 2020


On Fri, Sep 25, 2020 at 02:51:45PM +0200, Alwin Antreich wrote:
> Signed-off-by: Alwin Antreich <a.antreich at proxmox.com>
> ---
> Note: The footnote in the title section broke the link building for that
>       footnote when used with a variable on the beginning of the url.
>       The parser seems to look for an http(s) and considers it text
>       otherwise. But interestingly it worked with the other footnotes.
> 
>       Should my note rather go into the commit message?
> 
>  pveceph.adoc | 6 ++++--
>  1 file changed, 4 insertions(+), 2 deletions(-)
> 
> diff --git a/pveceph.adoc b/pveceph.adoc
> index baf0988..0f94b97 100644
> --- a/pveceph.adoc
> +++ b/pveceph.adoc
> @@ -58,12 +58,14 @@ and VMs on the same node is possible.
>  To simplify management, we provide 'pveceph' - a tool to install and
>  manage {ceph} services on {pve} nodes.
>  
> -.Ceph consists of a couple of Daemons footnote:[Ceph intro https://docs.ceph.com/docs/{ceph_codename}/start/intro/], for use as a RBD storage:
> +.Ceph consists of a couple of Daemons, for use as a RBD storage:
>  - Ceph Monitor (ceph-mon)
>  - Ceph Manager (ceph-mgr)
>  - Ceph OSD (ceph-osd; Object Storage Daemon)
>  
> -TIP: We highly recommend to get familiar with Ceph's architecture
> +TIP: We highly recommend to get familiar with Ceph
> +footnote:[Ceph intro https://docs.ceph.com/docs/{ceph_codename}/start/intro/],
> +its architecture
>  footnote:[Ceph architecture https://docs.ceph.com/docs/{ceph_codename}/architecture/]
>  and vocabulary
>  footnote:[Ceph glossary https://docs.ceph.com/docs/{ceph_codename}/glossary].
> -- 
> 2.27.0
May one of the maintainers please review my patches? Thanks.





More information about the pve-devel mailing list