Github messages for voidlinux
 help / color / Atom feed
* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
@ 2020-04-29 18:11 ` Chocimier
  2020-04-29 22:09 ` ericonr
                   ` (15 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: Chocimier @ 2020-04-29 18:11 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 272 bytes --]

New comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621376154

Comment:
Good idea.

Since we avoid to package anything without tag, we should rather set a good example and use tags for own stuff too.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
  2020-04-29 18:11 ` [WIP] New package: void-docs-2020.04.18 Chocimier
@ 2020-04-29 22:09 ` ericonr
  2020-04-30 11:31 ` travankor
                   ` (14 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-04-29 22:09 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 244 bytes --]

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621491731

Comment:
@Chocimier good point! I will talk to @bobertlo about this to see when he thinks we could tag the docs.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
  2020-04-29 18:11 ` [WIP] New package: void-docs-2020.04.18 Chocimier
  2020-04-29 22:09 ` ericonr
@ 2020-04-30 11:31 ` travankor
  2020-04-30 11:31 ` travankor
                   ` (13 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: travankor @ 2020-04-30 11:31 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 332 bytes --]

New comment by travankor on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621776418

Comment:
What do tags mean for documentation? Is there a 1.0? Should people just git clone like with xbps-src?

Also not a fun of shipping a md reader as part of the base system. How about mandoc?

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (2 preceding siblings ...)
  2020-04-30 11:31 ` travankor
@ 2020-04-30 11:31 ` travankor
  2020-04-30 11:43 ` travankor
                   ` (12 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: travankor @ 2020-04-30 11:31 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 332 bytes --]

New comment by travankor on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621776418

Comment:
What do tags mean for documentation? Is there a 1.0? Should people just git clone like with xbps-src?

Also not a fan of shipping a md reader as part of the base system. How about mandoc?

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (3 preceding siblings ...)
  2020-04-30 11:31 ` travankor
@ 2020-04-30 11:43 ` travankor
  2020-04-30 14:35 ` ericonr
                   ` (11 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: travankor @ 2020-04-30 11:43 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 424 bytes --]

New comment by travankor on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621776418

Comment:
What do tags mean for documentation? Is there a 1.0? Documentation is updated on a "rolling"-release basis. Should people just git clone like with xbps-src, which will give you the latest info?

Also not a fan of shipping a md reader as part of the base system. How about mandoc?

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (4 preceding siblings ...)
  2020-04-30 11:43 ` travankor
@ 2020-04-30 14:35 ` ericonr
  2020-05-01  1:46 ` travankor
                   ` (10 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-04-30 14:35 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 576 bytes --]

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-621893470

Comment:
@travankor the idea is to ship something with the livecd, primarily. That's why we'd need to tag a version. I agree that documentation is rolling in nature, but we can try to make a target for a tagged version by closing some important issues.

mandoc seems like an interesting option, however. I used pandoc to convert the files into roff, and `mandoc -a SUMMARY` actually looks really good. And it should come with the base system!

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (5 preceding siblings ...)
  2020-04-30 14:35 ` ericonr
@ 2020-05-01  1:46 ` travankor
  2020-05-01  1:47 ` travankor
                   ` (9 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: travankor @ 2020-05-01  1:46 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 364 bytes --]

New comment by travankor on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-622209050

Comment:
Can the live cd's just use master of void-docs, like they do with void-packages (i.e. use the lastest version of everything when generated)? I don't know what @bobertlo says, but release tagging might be too bureaucratic.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (6 preceding siblings ...)
  2020-05-01  1:46 ` travankor
@ 2020-05-01  1:47 ` travankor
  2020-05-01 17:25 ` Chocimier
                   ` (8 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: travankor @ 2020-05-01  1:47 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 363 bytes --]

New comment by travankor on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-622209050

Comment:
Can the live cds just use master of void-docs, like they do with void-packages (i.e. use the lastest version of everything when generated)? I don't know what @bobertlo says, but release tagging might be too bureaucratic.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (7 preceding siblings ...)
  2020-05-01  1:47 ` travankor
@ 2020-05-01 17:25 ` Chocimier
  2020-05-01 23:10 ` CameronNemo
                   ` (7 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: Chocimier @ 2020-05-01 17:25 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 421 bytes --]

New comment by Chocimier on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-622481270

Comment:
Tag means that tagged version is in reviewed, usable state, not eg. in middle of some series of patches, and that there are enough changes from previous tag to update.

I guess it's easier to take existing package into image, than build it from master during image generation.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (8 preceding siblings ...)
  2020-05-01 17:25 ` Chocimier
@ 2020-05-01 23:10 ` CameronNemo
  2020-05-02 21:26 ` bobertlo
                   ` (6 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: CameronNemo @ 2020-05-01 23:10 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 580 bytes --]

New comment by CameronNemo on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-622605404

Comment:
Well the void-docs are pushed to the website directly from master, so theoretically it should not be in the middle of updates. One option could be timing the doc tags with live image builds.

As far the file format discussion, I would prefer shipping both the markdown and compiled mdbook. This would allow for a simple and quick `less path/to/doc` as well as the option of using a text or non-text browser to navigate the full book.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (9 preceding siblings ...)
  2020-05-01 23:10 ` CameronNemo
@ 2020-05-02 21:26 ` bobertlo
  2020-05-02 21:33 ` bobertlo
                   ` (5 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: bobertlo @ 2020-05-02 21:26 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 343 bytes --]

New comment by bobertlo on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-623015408

Comment:
@ericonr there is a lot of pending content. i think merging some of this might be appropriate before tagging. on the other hand tagging now before we start getting the changes in might make sense also.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (10 preceding siblings ...)
  2020-05-02 21:26 ` bobertlo
@ 2020-05-02 21:33 ` bobertlo
  2020-05-02 23:50 ` [PR PATCH] [Updated] " ericonr
                   ` (4 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: bobertlo @ 2020-05-02 21:33 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 412 bytes --]

New comment by bobertlo on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-623016118

Comment:
I think there should be tags for sure. At least as far as staying consistent. We wont ever pull from master. The package should be fairly small so I think some regular interval when there are small changes and then manual updates for larger changes would be appropriate.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [PR PATCH] [Updated] [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (11 preceding siblings ...)
  2020-05-02 21:33 ` bobertlo
@ 2020-05-02 23:50 ` ericonr
  2020-05-03  0:04 ` ericonr
                   ` (3 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-05-02 23:50 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 1028 bytes --]

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages void-docs
https://github.com/void-linux/void-packages/pull/21453

[WIP] New package: void-docs-2020.04.18.
So, instead of having versions of void-docs tagged and used here, I thought it'd be better to just select a commit and roll with it. This is totally subject to change, though.

This package stores the docs inside `/usr/share/void-docs/`, for now. It'd be useful for inclusion inside the live images that void ships. In the case this is accepted, it would make sense to include a terminal markdown formatter as well (either mdcat or glow). I also think it would be interesting to inform the user that these pages exist, perhaps as a warning on the motd? I don't know how I'd go about including it.

This is WIP for now, but intends to close https://github.com/void-linux/void-docs/issues/214 !

A patch file from https://github.com/void-linux/void-packages/pull/21453.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-void-docs-21453.patch --]
[-- Type: text/x-diff, Size: 1604 bytes --]

From 1311e73e2f3c6289073cfa21e77102cd8a26cfd8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 29 Apr 2020 02:17:02 -0300
Subject: [PATCH] New package: void-docs-2020.04.18.

---
 srcpkgs/void-docs/template | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 srcpkgs/void-docs/template

diff --git a/srcpkgs/void-docs/template b/srcpkgs/void-docs/template
new file mode 100644
index 00000000000..84fa6bbf0e3
--- /dev/null
+++ b/srcpkgs/void-docs/template
@@ -0,0 +1,38 @@
+# Template file for 'void-docs'
+pkgname=void-docs
+version=0.0.0.20200418
+revision=1
+_commit=029fd1683100ae36c87e29227af8de4cadd1095b
+wrksrc="${pkgname}-${_commit}"
+build_style=meta
+hostmakedepends="mdBook fd pandoc"
+short_desc="Documentation for Void Linux"
+maintainer="Érico Nogueira <ericonr@disroot.com>"
+license="CC-BY-SA-4.0"
+homepage="https://docs.voidlinux.org/"
+distfiles="https://github.com/void-linux/void-docs/archive/${_commit}.tar.gz"
+checksum=845e56b88bfa4a27ff42705051b319a92c96b02113122237ede58282f12648e8
+
+do_build() {
+	mdbook build
+
+	mkdir -p mandoc
+	fd -t d "" src/ -x mkdir -p "mandoc/{}"
+	fd "\.md" src/ -x pandoc \
+		-V "title={/.}" -V "section=5" -V "header='Void Docs'" -s \
+		-o "mandoc/{.}.7" "{}"
+}
+
+do_install() {
+	_dest_dir=usr/share/void-docs
+
+	# compiled book
+	vmkdir $_dest_dir/html
+	vcopy book/* $_dest_dir/html
+	# markdown source
+	vmkdir $_dest_dir/markdown
+	vcopy src/* $_dest_dir/markdown
+	# mandoc
+	vmkdir $_dest_dir/mandoc
+	vcopy mandoc/src/* $_dest_dir/mandoc
+}

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (12 preceding siblings ...)
  2020-05-02 23:50 ` [PR PATCH] [Updated] " ericonr
@ 2020-05-03  0:04 ` ericonr
  2020-05-17  4:33 ` [PR PATCH] [Updated] " ericonr
                   ` (2 subsequent siblings)
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-05-03  0:04 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 1179 bytes --]

New comment by ericonr on void-packages repository

https://github.com/void-linux/void-packages/pull/21453#issuecomment-623031734

Comment:
Anyone here with good findutils skills? I used `fd` instead because running commands with it is way easier.

So, right now, we have:

* markdown sources -> straight from the git repo
* HTML book -> generated by mdbook, can be opened by a TUI or GUI browser. I'd expect someone who is doing a graphical install to have an internet connection, so this probably isn't as useful, but it's easy enough to include
* mandoc pages -> generated with pandoc (wonderful tool, btw). We could customize page titles a bit more too, to get more unique ones. Requires `mandoc -a file` to browse files with a pager, and obviously can't link directly to  another file. I used `file.7`, because 7 is the misc category. If you have better suggestions please let me know. @travankor it's the closest I could get to texinfo :p

The PR is still WIP, so when we decide on a tagging strategy I will update it to use that instead.

@bobertlo regarding tagging, I'd like to wait for a few PRs too. Stuff like chroot guides would be pretty useful, I think.

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [PR PATCH] [Updated] [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (13 preceding siblings ...)
  2020-05-03  0:04 ` ericonr
@ 2020-05-17  4:33 ` ericonr
  2020-06-01  5:16 ` ericonr
  2020-06-01  5:40 ` ericonr
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-05-17  4:33 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 1028 bytes --]

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages void-docs
https://github.com/void-linux/void-packages/pull/21453

[WIP] New package: void-docs-2020.04.18.
So, instead of having versions of void-docs tagged and used here, I thought it'd be better to just select a commit and roll with it. This is totally subject to change, though.

This package stores the docs inside `/usr/share/void-docs/`, for now. It'd be useful for inclusion inside the live images that void ships. In the case this is accepted, it would make sense to include a terminal markdown formatter as well (either mdcat or glow). I also think it would be interesting to inform the user that these pages exist, perhaps as a warning on the motd? I don't know how I'd go about including it.

This is WIP for now, but intends to close https://github.com/void-linux/void-docs/issues/214 !

A patch file from https://github.com/void-linux/void-packages/pull/21453.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-void-docs-21453.patch --]
[-- Type: text/x-diff, Size: 1666 bytes --]

From ccf51a14588daaeb2d047b24e9a7690baac6541b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 29 Apr 2020 02:17:02 -0300
Subject: [PATCH] New package: void-docs-2020.04.18.

---
 srcpkgs/void-docs/template | 41 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 srcpkgs/void-docs/template

diff --git a/srcpkgs/void-docs/template b/srcpkgs/void-docs/template
new file mode 100644
index 00000000000..89e85ada8bf
--- /dev/null
+++ b/srcpkgs/void-docs/template
@@ -0,0 +1,41 @@
+# Template file for 'void-docs'
+pkgname=void-docs
+version=0.0.0.20200418
+revision=1
+_commit=029fd1683100ae36c87e29227af8de4cadd1095b
+wrksrc="${pkgname}-${_commit}"
+hostmakedepends="mdBook fd pandoc"
+short_desc="Documentation for Void Linux"
+maintainer="Érico Nogueira <ericonr@disroot.com>"
+license="CC-BY-SA-4.0"
+homepage="https://docs.voidlinux.org/"
+distfiles="https://github.com/void-linux/void-docs/archive/${_commit}.tar.gz"
+checksum=845e56b88bfa4a27ff42705051b319a92c96b02113122237ede58282f12648e8
+
+do_build() {
+	mdbook build
+
+	mkdir -p mandoc
+	fd -t d "" src/ -x mkdir -p "mandoc/{}"
+	fd "\.md" src/ -x pandoc \
+		-V "title={/.}" -V "section=5" -V "header='Void Docs'" -s \
+		-o "mandoc/{.}.7" "{}"
+}
+
+do_install() {
+	_dest_dir=usr/share/void-docs
+
+	# compiled book
+	vmkdir $_dest_dir/html
+	if [ -r book/html/ ] ; then
+		vcopy book/html/* $_dest_dir/html
+	else
+		vcopy book/* $_dest_dir/html
+	fi
+	# markdown source
+	vmkdir $_dest_dir/markdown
+	vcopy src/* $_dest_dir/markdown
+	# mandoc
+	vmkdir $_dest_dir/mandoc
+	vcopy mandoc/src/* $_dest_dir/mandoc
+}

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [PR PATCH] [Updated] [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (14 preceding siblings ...)
  2020-05-17  4:33 ` [PR PATCH] [Updated] " ericonr
@ 2020-06-01  5:16 ` ericonr
  2020-06-01  5:40 ` ericonr
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-06-01  5:16 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 1028 bytes --]

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages void-docs
https://github.com/void-linux/void-packages/pull/21453

[WIP] New package: void-docs-2020.04.18.
So, instead of having versions of void-docs tagged and used here, I thought it'd be better to just select a commit and roll with it. This is totally subject to change, though.

This package stores the docs inside `/usr/share/void-docs/`, for now. It'd be useful for inclusion inside the live images that void ships. In the case this is accepted, it would make sense to include a terminal markdown formatter as well (either mdcat or glow). I also think it would be interesting to inform the user that these pages exist, perhaps as a warning on the motd? I don't know how I'd go about including it.

This is WIP for now, but intends to close https://github.com/void-linux/void-docs/issues/214 !

A patch file from https://github.com/void-linux/void-packages/pull/21453.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-void-docs-21453.patch --]
[-- Type: text/x-diff, Size: 1545 bytes --]

From 0455a9a735ebb8b7621b295e702e39f6a8e2a627 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 29 Apr 2020 02:17:02 -0300
Subject: [PATCH] New package: void-docs-2020.04.18.

---
 srcpkgs/void-docs/template | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 srcpkgs/void-docs/template

diff --git a/srcpkgs/void-docs/template b/srcpkgs/void-docs/template
new file mode 100644
index 00000000000..5e63c841759
--- /dev/null
+++ b/srcpkgs/void-docs/template
@@ -0,0 +1,37 @@
+# Template file for 'void-docs'
+pkgname=void-docs
+version=0.0.0.20200418
+revision=1
+_commit=029fd1683100ae36c87e29227af8de4cadd1095b
+wrksrc="${pkgname}-${_commit}"
+hostmakedepends="mdBook fd pandoc"
+short_desc="Documentation for Void Linux"
+maintainer="Érico Nogueira <ericonr@disroot.org>"
+license="CC-BY-SA-4.0"
+homepage="https://docs.voidlinux.org/"
+distfiles="https://github.com/void-linux/void-docs/archive/${_commit}.tar.gz"
+checksum=845e56b88bfa4a27ff42705051b319a92c96b02113122237ede58282f12648e8
+
+do_build() {
+	./build.sh
+}
+
+do_install() {
+	_dest_dir=usr/share/void-docs
+
+	# compiled book
+	vmkdir $_dest_dir/html
+	if [ -r book/html/ ] ; then
+		vcopy book/html/* $_dest_dir/html
+	else
+		vcopy book/* $_dest_dir/html
+	fi
+	# markdown source
+	vmkdir $_dest_dir/markdown
+	vcopy src/* $_dest_dir/markdown
+	# mandoc
+	vmkdir $_dest_dir/mandoc
+	vcopy mandoc/src/* $_dest_dir/mandoc
+	# reference man page
+	vcopy void-docs.7 usr/share/man/man7
+}

^ permalink raw reply	[flat|nested] 17+ messages in thread

* Re: [PR PATCH] [Updated] [WIP] New package: void-docs-2020.04.18.
       [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
                   ` (15 preceding siblings ...)
  2020-06-01  5:16 ` ericonr
@ 2020-06-01  5:40 ` ericonr
  16 siblings, 0 replies; 17+ messages in thread
From: ericonr @ 2020-06-01  5:40 UTC (permalink / raw)
  To: ml


[-- Attachment #1: Type: text/plain, Size: 1028 bytes --]

There is an updated pull request by ericonr against master on the void-packages repository

https://github.com/ericonr/void-packages void-docs
https://github.com/void-linux/void-packages/pull/21453

[WIP] New package: void-docs-2020.04.18.
So, instead of having versions of void-docs tagged and used here, I thought it'd be better to just select a commit and roll with it. This is totally subject to change, though.

This package stores the docs inside `/usr/share/void-docs/`, for now. It'd be useful for inclusion inside the live images that void ships. In the case this is accepted, it would make sense to include a terminal markdown formatter as well (either mdcat or glow). I also think it would be interesting to inform the user that these pages exist, perhaps as a warning on the motd? I don't know how I'd go about including it.

This is WIP for now, but intends to close https://github.com/void-linux/void-docs/issues/214 !

A patch file from https://github.com/void-linux/void-packages/pull/21453.patch is attached

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: github-pr-void-docs-21453.patch --]
[-- Type: text/x-diff, Size: 1571 bytes --]

From a4a9da02a216df0de7fdf6740395daa69ce50a23 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=89rico=20Rolim?= <erico.erc@gmail.com>
Date: Wed, 29 Apr 2020 02:17:02 -0300
Subject: [PATCH] New package: void-docs-2020.06.01.

---
 srcpkgs/void-docs/template | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 srcpkgs/void-docs/template

diff --git a/srcpkgs/void-docs/template b/srcpkgs/void-docs/template
new file mode 100644
index 00000000000..3e80f669392
--- /dev/null
+++ b/srcpkgs/void-docs/template
@@ -0,0 +1,38 @@
+# Template file for 'void-docs'
+pkgname=void-docs
+version=2020.06.01
+revision=1
+_commit=80c308009996b598e51fc84294ae460e9e280219
+wrksrc="${pkgname}-${_commit}"
+hostmakedepends="mdBook fd pandoc"
+short_desc="Documentation for Void Linux"
+maintainer="Érico Nogueira <ericonr@disroot.org>"
+license="CC-BY-SA-4.0"
+homepage="https://docs.voidlinux.org/"
+distfiles="https://github.com/void-linux/void-docs/archive/${_commit}.tar.gz"
+checksum=9f7d30e04f47734ca6dd4214a5bc0ee8b552e9587ed4f0b9c7953f47e2c97423
+
+do_build() {
+	./build.sh
+}
+
+do_install() {
+	_dest_dir=usr/share/void-docs
+
+	# compiled book
+	vmkdir $_dest_dir/html
+	if [ -r book/html/ ] ; then
+		vcopy book/html/* $_dest_dir/html
+	else
+		vcopy book/* $_dest_dir/html
+	fi
+	# markdown source
+	vmkdir $_dest_dir/markdown
+	vcopy src/* $_dest_dir/markdown
+	# mandoc
+	vmkdir $_dest_dir/mandoc
+	vcopy mandoc/src/* $_dest_dir/mandoc
+	# reference man page
+	vmkdir usr/share/man/man7/
+	vcopy void-docs.7 usr/share/man/man7
+}

^ permalink raw reply	[flat|nested] 17+ messages in thread

end of thread, back to index

Thread overview: 17+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
     [not found] <gh-mailinglist-notifications-41a7ca26-5023-4802-975b-f1789d68868e-void-packages-21453@inbox.vuxu.org>
2020-04-29 18:11 ` [WIP] New package: void-docs-2020.04.18 Chocimier
2020-04-29 22:09 ` ericonr
2020-04-30 11:31 ` travankor
2020-04-30 11:31 ` travankor
2020-04-30 11:43 ` travankor
2020-04-30 14:35 ` ericonr
2020-05-01  1:46 ` travankor
2020-05-01  1:47 ` travankor
2020-05-01 17:25 ` Chocimier
2020-05-01 23:10 ` CameronNemo
2020-05-02 21:26 ` bobertlo
2020-05-02 21:33 ` bobertlo
2020-05-02 23:50 ` [PR PATCH] [Updated] " ericonr
2020-05-03  0:04 ` ericonr
2020-05-17  4:33 ` [PR PATCH] [Updated] " ericonr
2020-06-01  5:16 ` ericonr
2020-06-01  5:40 ` ericonr

Github messages for voidlinux

Archives are clonable: git clone --mirror http://inbox.vuxu.org/voidlinux-github

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://inbox.vuxu.org/vuxu.github.voidlinux


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git