void-linux / void-linux/void-docs

Advanced installation guides

Open
#85 26 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
CSS
Stars
217
Forks
212
Avg merge
2d 21h
Merged PRs (30d)
1

Description

I plan to start working on this, but am looking for input on how to handle this. There are SO many installation guides on the wiki, with SO much duplication. My proposal is to create a fleshed out "advanced installation" guide, along with other specific guides, which will only offer differences from the main guide.

Advanced Installation Guide

This guide will detail "manual" installation from start to finish, more in the style of the "live image installer" guide. This guide would be formal and fleshed out, mentioning alternatives to the given procedures. Topics would include:

  • preparing and mounting partitions
  • manually installing a system with xbps-install
  • basic configuration of the system afterwards, up to the point of being able to use the rest of the manual.
  • bootloader: only cover "regular" bootloader in this guide for BIOS/UEFI systems
Alternative Installation Guides

These guides will in every instance possible just reference the "main" advanced installation guide, and not duplicate those steps. They will only present changes to that procedure, and enough context for the user to be able to follow what is happening. Initial topics could include:

  • encrypted disks
  • raspberry pi
  • other embedded systems
  • dual booting
  • alternative bootloaders
  • etc
Proposed Process
  1. Write a minimal installation guide. It should cover anything needed to go from nothing to a working system, but not try to cram everything from the wiki into it. A minimum viable product to manually install a system.
  2. Write Alternative Guides for specific use cases and hardware, referencing them as needed from the main guide.
  3. ???
  4. Profit

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing installation guides on the wiki and compare their duplicated content with the proposed advanced installation and alternative-guide structure. Confirm the scope and organization with maintainers before editing. Done means a minimal manual installation guide and focused guides for alternatives such as encrypted disks, Raspberry Pi, dual booting, and bootloaders, without duplicating the main procedure.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.