search

void-linux / void-docs

mdbook source for docs.voidlinux.org
https://docs.voidlinux.org
Creative Commons Attribution Share Alike 4.0 International
163 stars 182 forks source link

Tracking: wiki content still to be added to the Handbook #327

Open flexibeast opened 4 years ago

flexibeast commented 4 years ago

i've now completed a low-hanging-fruit pass of wiki articles to mark articles that i'm confident are either:

i've marked such articles by renaming them to include a trailing dash, to make them visible on the AllPages wiki page. In the cases where there's a Handbook section directly corresponding to a wiki article - which is not always the case - i've removed the article contents and replaced it with the text "As this wiki is deprecated, and will soon disappear, please refer to \<link to Handbook section>."

i have intentionally not provided redirects from the old page name to the new page name, so that search engines reduce the ranking of the wiki in search results. (A Google search for 'void pulseaudio' currently ranks the wiki above the Handbook.)

The following is a list of all articles not so marked by this process:

This list looks more substantial than it probably actually is: i've very much erred on the side of caution during the marking process (hence my reference to a "low-hanging-fruit pass"). Thus, for example:

and so on.

i'm now opening this issue to provide a single location for tracking what still needs to be done before we can decommission the wiki, and so that members of the Void team can help out with a second pass. As people provide their thoughts about the articles in the above list, i'll add text next to each item to reflect its status.

ericonr commented 4 years ago

Made everything into a checkbox, so we can more easily mark what's already been dealt with. Thanks for looking into this!

flexibeast commented 4 years ago

@ericonr: Great, thanks. :-) We should make sure that nothing gets checked off without a short explanation beside it - i don't want people to have to read through (what will probably end up being) a long comment thread to find an explanation.

flexibeast commented 4 years ago

Please be careful when editing the comment containing the task list! Twice now i've done an update, only to find that GitHub has not only not included the update, it's reverted to a much earlier version. :-/ i couldn't find a way to manually revert to the penultimate revision; if only there were a VCS that allowed that. :-P

jeffayle commented 4 years ago

re what #177 covers:

yes

no

flexibeast commented 4 years ago

@jeffayle: Thanks, updated.

ericonr commented 4 years ago

Could we try to post about this on reddit and ask for help?

flexibeast commented 4 years ago

i'm preparing a post for /r/voidlinux about recent work on the Handbook, and the post includes a link to this issue.

flexibeast commented 4 years ago

@bobertlo: Might you be able to go through the list as it currently stands, and indicate whether any of the unchecked items could be checked off?

bobertlo commented 4 years ago

@flexibeast will do. not tonight but ill keep this in notifications

ericonr commented 4 years ago

Given that the wiki is (temporarily?) down, http://web.archive.org/web/20190228221339/https://wiki.voidlinux.org/Special:AllPages

The HTTP link works better http://web.archive.org/web/20190228221339/http://wiki.voidlinux.org/Special:AllPages

ericonr commented 4 years ago

Updated the current check list with some small changes.

ahesford commented 4 years ago

Regarding Samba, there is nothing specific to Void and little of general value in the archived page. I see no reason to preserve it.

bobertlo commented 4 years ago

I think Steam is covered by 3rd party software. It takes some doing to use the official package, but the flatpak works great.

bobertlo commented 4 years ago

I don't see anything that jumps out as important void specific information in xfce

flexibeast commented 4 years ago

@void-linux/pkg-committers: Is any of the information in https://wiki.voidlinux.org/Known_Issues still relevant?

cinerea0 commented 4 years ago

Should the Zabbix and Zram pages be added to the checklist? The former has some Void-specific knowledge and the latter contains instructions for setting up Zram that seem to be different from any other tutorial on the subject. If so, I'd be happy to port them myself.

flexibeast commented 4 years ago

@cinerea0: Thanks for the offer. :-) However, as the trailing dash in the page names indicate, i believe they shouldn't be included in the Handbook:

Vaelatern commented 4 years ago

Re: Salt

Knowing the grains on the system is good.

Listing that the config files are under /etc/salt by default, and services are normal, is good.

Is it within the purview of the handbook to list github issues relevant to Void support in salt?

cinerea0 commented 3 years ago

Given recent discussion on IRC, I think it would be best to remove the "Create Git Versions of Packages" entry because it's out of scope for the handbook and the details within are better covered by the xbps-src manual.

ghost commented 3 years ago

Another page that has not yet been migrated to The Handbook: https://wiki.voidlinux.org/Sway_-

ericonr commented 3 years ago

@jpie726 That page is outdated and not in scope for the Void Handbook.

hk0O7 commented 2 years ago

Fail2ban still seems to be missing.