From mboxrd@z Thu Jan 1 00:00:00 1970 X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org X-Spam-Level: X-Spam-Status: No, score=0.2 required=5.0 tests=DKIM_SIGNED,DKIM_VALID, DKIM_VALID_AU,FREEMAIL_FROM,HTML_MESSAGE,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED,RCVD_IN_SBL_CSS,UNPARSEABLE_RELAY autolearn=no autolearn_force=no version=3.4.4 Received: (qmail 8378 invoked from network); 29 Mar 2021 03:40:28 -0000 Received: from zero.zsh.org (2a02:898:31:0:48:4558:7a:7368) by inbox.vuxu.org with ESMTPUTF8; 29 Mar 2021 03:40:28 -0000 ARC-Seal: i=1; cv=none; a=rsa-sha256; d=zsh.org; s=rsa-20200801; t=1616989228; b=rKCJPxfbC8m5dTcOf6ikqLYxnfoqDqb7A809Jv77ovzG7DxZKW5JMc1WlpuDEuv0zl13Mp6ZYj zhxhsfzz/mt/GKa3NoAdaRWIF3Kkky3/O7e9yjPsQzLK6GpxusDkVm28yM9CDZy37OKimxXDO5 IqixYGuZJ78HsknfIgDPijnL0qI/cQU8bAilLoSKDHyd5BhKq8ZzhG33MV3K3XcYch4ETNo78Z vGkH41pYs+aHn/GFjg1aGr7z3H+nY82q7+zmNMGy+4o1RaiYcxO6eCMj/nIPGEBAikvShp9X+Q 3LtSK9YO8KkhFDJrL6kZJOZ+rQSZ5trnpc/FsefMLt76/w==; ARC-Authentication-Results: i=1; zsh.org; iprev=pass (mr85p00im-ztdg06011801.me.com) smtp.remote-ip=17.58.23.199; dkim=pass header.d=icloud.com header.s=1a1hai header.a=rsa-sha256; dmarc=pass header.from=icloud.com; arc=none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed; d=zsh.org; s=rsa-20200801; t=1616989228; bh=VYj/6/xwldYIfb/jECo6YdLq0CPRF4KBwQYISviIXX8=; h=List-Archive:List-Owner:List-Post:List-Unsubscribe:List-Subscribe:List-Help: List-Id:Sender:References:To:Cc:In-Reply-To:Date:Subject:MIME-Version: Content-Type:Message-ID:From:DKIM-Signature:DKIM-Signature; b=pItA1nDBBXc+eir27x93bm3n9t6IKaSzILTVVq/wzV7/mU1rwtKM11o+U68kHk6J+c5kj5bPTu YpkP/27xuuzmO9XxHlQLOWjtRzIoLA1TfinuHbfFWBtaaz99QlII5VPbn3nsghw1B2pUAwpxRa URCoHPKlq6fy6Mm15ZPEc4qj9X1D7jNxUxejyYjYOlukGkaG9dm2IZdXVjJZR9cOySbrhMWj1f HUAq7zzypwpYiaYZj7ATC6iddfVa0KQxCKmxgQRdp3GMdTcgQgC7Z3NUUTcnxu33IKr3BTxK9n WIP7ijwrYh0bHUQNZpbu+JcVHE0lY74wer4zo0szeNm8XA==; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=zsh.org; s=rsa-20200801; h=List-Archive:List-Owner:List-Post:List-Unsubscribe: List-Subscribe:List-Help:List-Id:Sender:References:To:Cc:In-Reply-To:Date: Subject:Mime-Version:Content-Type:Message-Id:From:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID; bh=CRoq5bUPGNMNPj6PoxLRSV41N+1IxSR0LXJgp30jsAc=; b=FFImviPWy8sGxMdDGpfBzJWJtI ew4Ka3L77EWxvrbZyrVgvYZN5WQ5WPl2j1XSgs0Q9MLFoJrPUTVa3p5UUYM0551Lf8FzYSlScozfm pKtA2r4IFoESCbrqPykbubZWsr2/u1TDWyBSUp5wR9tOHyfZ72PfWUzczQT79mt3HLv43iAoyLyxw EBaqdXZLWPe7FKyfUrSg7Mb/YNa15yLgGwovfAiO2ejUmU6C6No6uNZbKWdMzPhthcpdcQredK0Yw Kn43HJ1lwAcvXwNLqNKeZKJi8lTFKgv40NRQIE7pqafwhCMMEIGR4+xgXH7Px3rSINJc41/JxWrYX Au8TbRdQ==; Received: from authenticated user by zero.zsh.org with local id 1lQilJ-0009yy-BT; Mon, 29 Mar 2021 03:40:21 +0000 Authentication-Results: zsh.org; iprev=pass (mr85p00im-ztdg06011801.me.com) smtp.remote-ip=17.58.23.199; dkim=pass header.d=icloud.com header.s=1a1hai header.a=rsa-sha256; dmarc=pass header.from=icloud.com; arc=none Received: from mr85p00im-ztdg06011801.me.com ([17.58.23.199]:57977) by zero.zsh.org with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) id 1lQil0-0009oD-Gr; Mon, 29 Mar 2021 03:40:03 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=icloud.com; s=1a1hai; t=1616989200; bh=CRoq5bUPGNMNPj6PoxLRSV41N+1IxSR0LXJgp30jsAc=; h=From:Message-Id:Content-Type:Mime-Version:Subject:Date:To; b=EvT7e5ZldaRmiyKzoFfClDR/wAfKXiVLU7k8tEoXsfpCA4gsyNh8V2z7avAPP5m1C Z46sCJC6W0OgUGlgnLbIgcxxeC+yCgDLOHChHgUMLgL3FSnM4S9iyyCfYcbr1MsbHC 0P7Hy1azBSdgNdWfPSyaC9D39E6l5b8VoioXQ+CNyDt/3vuIbTOyjJO/J5YDeAnauP MqasWKw4mysuQTOHFOMfjbB+kimo3Q7IwJe7h32SWoCVDxfMcc3bN4kxXDQbyb4pvj +O8pkFlgi8z9iJpd3qPmuBWlqT4bPxDC67bnYA08xq2fNL588x7ZTKmhUkj6Nr6Xav Jsx29R/4MxB1A== Received: from [100.65.5.224] (unknown [64.136.145.72]) by mr85p00im-ztdg06011801.me.com (Postfix) with ESMTPSA id BCEA4C03F6; Mon, 29 Mar 2021 03:40:00 +0000 (UTC) From: Austin Traver Message-Id: Content-Type: multipart/alternative; boundary="Apple-Mail=_195031A4-7782-4E01-BB08-FE4B5F787D9F" Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.60.0.2.21\)) Subject: Re: I'd like to help maintain the Zsh Web Page Date: Sun, 28 Mar 2021 20:39:59 -0700 In-Reply-To: <84773-1616980819.919111@ybx2.QGzt.Gdnm> Cc: zsh-workers@zsh.org To: Oliver Kiddle References: <81983-1616976142.953383@GxW7.Jtw5.jOhI> <481B0356-2B76-415A-8C1E-2BB6828420FC@icloud.com> <84773-1616980819.919111@ybx2.QGzt.Gdnm> X-Mailer: Apple Mail (2.3654.60.0.2.21) X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:6.0.369,18.0.761 definitions=2021-03-29_02:2021-03-26,2021-03-29 signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=0 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-2006250000 definitions=main-2103290026 X-Seq: 48302 Archived-At: X-Loop: zsh-workers@zsh.org Errors-To: zsh-workers-owner@zsh.org Precedence: list Precedence: bulk Sender: zsh-workers-request@zsh.org X-no-archive: yes List-Id: List-Help: List-Subscribe: List-Unsubscribe: List-Post: List-Owner: List-Archive: Archived-At: --Apple-Mail=_195031A4-7782-4E01-BB08-FE4B5F787D9F Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > The actual documentation is=E2=80=A6 not written in HTML but in a = macro language named yodl I've worked with groff in the past, so I'm at least acquainted with = macro packages such as mdoc. Yodl, I'm still working on learning, but I = see this as a chance to learn something new. > The man pages are possibly the most > important form for the documentation. I agree entirely, don't know what I'd do without them! > I'm not sure whether that can be > replicated from markdown but it really would need to be. texi2html is > quite configurable if we just want to tweak the web version of the > documentation. I'll make a first attempt using texi2html and let you guys know how it = goes. > I'm not saying it has to be this way forever but take the > time to understand it first so you don't end up doing a lot of work = that > goes to waste. In the past, I've learned the hard way what happens when developers = build software now and understand requirements later. Not a fun time for = anyone. I'll be sure to do this work in the correct order.=20 > The documentation is in a Doc directory alongside the source code - > https://git.code.sf.net/p/zsh/code > There are mirrors on github and gitlab if you prefer. > Sourceforge website content is https://git.code.sf.net/p/zsh/web > zsh.org website content is only the one file, so curl or saving from > firefox is probably easiest. >=20 > Oliver Sounds good! If I reach a checkpoint, I'll post it to = https://github.com/austintraver/zsh = Which remote (and branch) would I make a pull request to, when done?=20 Best, Austin= --Apple-Mail=_195031A4-7782-4E01-BB08-FE4B5F787D9F Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=utf-8
The = actual documentation is=E2=80=A6 not written in HTML but in a macro = language named yodl

I've = worked with groff in the past, so I'm at least acquainted with macro = packages such as mdoc. Yodl, I'm still working on learning, but I see = this as a chance to learn something new.

The man pages = are possibly the most
important form for the = documentation.

I = agree entirely, don't know what I'd do without them!

I'm not sure whether = that can be
replicated from markdown but it really would = need to be. texi2html is
quite configurable if we just = want to tweak the web version of the
documentation.

I'll = make a first attempt using texi2html and let you guys know how it = goes.

I'm not saying it has to be this way forever but take the
time to understand it first so you don't end up doing a lot = of work that
goes to waste.

In the past, I've learned the hard way what = happens when developers build software now and understand requirements later. Not a fun time for anyone. = I'll be sure to do this work in the correct order. 

The documentation is in a Doc directory alongside the source = code -
https://git.code.sf.net/p/zsh/code
There = are mirrors on github and gitlab if you prefer.
Sourceforge = website content is https://git.code.sf.net/p/zsh/web
zsh.org= website content is only the one file, so curl or saving from
firefox is probably easiest.

Oliver


Sounds good! If I reach a checkpoint, = I'll post it to https://github.com/austintraver/zsh
Which= remote (and branch) would I make a pull request to, when = done? 

Best,
Austin
= --Apple-Mail=_195031A4-7782-4E01-BB08-FE4B5F787D9F--