void-linux / void-linux/void-docs

Advanced installation guides

Ouverte
#85 26 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement help wanted
Langage dominant
CSS
Étoiles
217
Forks
212
Merge moyen
2 j 21 h
PR mergées (30 j)
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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par examiner les guides d’installation existants sur le wiki et comparez leur contenu dupliqué avec la structure proposée pour l’installation avancée et les guides alternatifs. Confirmez le périmètre et l’organisation avec les maintainers avant de modifier quoi que ce soit. La tâche est terminée lorsqu’il existe un guide minimal d’installation manuelle et des guides ciblés pour des alternatives telles que les disques chiffrés, Raspberry Pi, le double démarrage et les bootloaders, sans dupliquer la procédure principale.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.