Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
55 of 87 tasks
flexibeast opened this issue Jun 12, 2020 · 22 comments
Open
55 of 87 tasks

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

flexibeast opened this issue Jun 12, 2020 · 22 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@flexibeast
Copy link
Contributor

flexibeast commented Jun 12, 2020 •
edited by ericonr
Loading

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

  • satisfactorily covered by the Handbook; and/or
  • clearly out-of-scope for the Handbook (e.g. don't contain any Void-specific information beyond something like xbps-install <package>).

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:

  • the "Rfkill" article is probably not needed; we could instead briefly mention it in e.g. config/network/index.md (it's already mentioned in bluetooth.md);
  • the "Post Installation" article is probably adequately covered by various sections in the Handbook, but this needs to be confirmed;
  • the "Dmix" article might only require a mention of dmix in the "ALSA" section;

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
Copy link
Member

ericonr commented Jun 12, 2020

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

@flexibeast
Copy link
Contributor Author

@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.

@ericonr ericonr added good first issue Good for newcomers help wanted Extra attention is needed labels Jun 12, 2020
This was referenced Jun 13, 2020
Open
Merged
Merged
Open
@flexibeast
Copy link
Contributor Author

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
Copy link
Contributor

re what #177 covers:

yes

no

@flexibeast
Copy link
Contributor Author

@jeffayle: Thanks, updated.

@flexibeast flexibeast mentioned this issue Jun 20, 2020
Merged
This was referenced Jun 28, 2020
Closed
Closed
@brihadeesh brihadeesh mentioned this issue Jul 12, 2020
Closed
@flexibeast flexibeast mentioned this issue Jul 15, 2020
Closed
29 tasks
@ericonr
Copy link
Member

ericonr commented Jul 17, 2020

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

@flexibeast
Copy link
Contributor Author

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

@cinerea0 cinerea0 mentioned this issue Jul 29, 2020
Merged
@flexibeast
Copy link
Contributor Author

@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
Copy link
Contributor

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

@ericonr
Copy link
Member

ericonr commented Jul 31, 2020 •
edited
Loading

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
Copy link
Member

ericonr commented Aug 1, 2020 •
edited
Loading

Updated the current check list with some small changes.

@ahesford
Copy link
Member

ahesford commented Aug 3, 2020

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
Copy link
Contributor

bobertlo commented Aug 5, 2020

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

@bobertlo
Copy link
Contributor

bobertlo commented Aug 5, 2020

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

@flexibeast
Copy link
Contributor Author

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

@cinerea0
Copy link
Contributor

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
Copy link
Contributor Author

@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:

  • the Void-specific content in the Zabbix page is basically "install these packages and enable the services", which we expect users to be able to work out for themselves, using xbps-query to find the packages and the Handbook to learn how to enable services. There are literally hundreds of packages with services in the repos, and we don't want a page for each. And at any rate, setting up Zabbix is not something needed for a functioning Void system.

  • the Zram page basically isn't Void-specific, and the Handbook is not generally a place for non-Void-specific guides that happen to not be available elsewhere. (That's why, for example, my "D-Bus: the essentials" guide is hosted in my own repo, and not included in the Handbook.)

@Vaelatern
Copy link
Member

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
Copy link
Contributor

cinerea0 commented Apr 2, 2021

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
Copy link

ghost commented Jun 5, 2021

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

@ericonr
Copy link
Member

ericonr commented Jun 5, 2021

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

@hk0O7
Copy link

hk0O7 commented Dec 6, 2021

Fail2ban still seems to be missing.

@ghost ghost mentioned this issue Oct 8, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
8 participants
@jeffayle @flexibeast @bobertlo @Vaelatern @hk0O7 @ericonr @ahesford @cinerea0