[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Wiki: Setup the environment, e.g. "salsa" script / Request to review modified docs



Hi Christian,

Improving docs is a very important thing, I appreciate your effort.

I quickly went through thr diff off your changes and it seems that you've changed the wiki to mention that using quilt is not recommended. While gbp pq is what the python team prefers indeed, the python team policy does not prevent quilt usage and instead mentions explicitly that optionally quilt can be used. As such, I do not find mentioning "using quilt is not recommended" appropriate as it has the connotation "you should not use quilt". As someone who takes advantage of the policy leniency and find quilt easier than gbp pq, I thought this has to be mentioned.

Once again, improving the wiki is a great thing to do. Please keep up the good work :)

Best,
Ananthu


On 19 March 2024 10:47:07 am UTC, c.buhtz@posteo.jp wrote:
Hello together,

I still struggle with the docs but also improving them.

First of all please review my modifications to make sure there are no misleading errors in the content. I restructured the "Policy" section [1]. I shortened and rephrased the text. I also added a sub section "Setup and configure the system" with missing details.

I think in the long run I will add setup information to https://wiki.debian.org/Salsa and link to it from Python/GitPackaging wiki page.
Please see my Salsa related questions in the other thread.

As a side note: There is an open discussion at MoinWiki to improve the handling of headings and page titles [2]. The later should not be part of the TOC.

Best Regards,
Christian Buhtz

[1] -- <https://wiki.debian.org/Python/GitPackaging#Policies>
[2] -- <https://github.com/moinwiki/moin/issues/1648>


Reply to: