void-linux / void-linux/void-docs

Advanced installation guides

オープン
#85 コメント 26 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement help wanted
主要言語
CSS
スター
217
フォーク
212
平均マージ
2日 21時間
マージ済み PR(30日)
1

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、wiki にある既存のインストールガイドを確認し、重複している内容を、提案されている高度なインストールおよび代替ガイドの構成と比較します。編集する前に、メンテナーと対象範囲および構成を確認してください。暗号化ディスク、Raspberry Pi、デュアルブート、ブートローダーなどの代替手段について、メインの手順を重複させない最小限の手動インストールガイドと、目的を絞ったガイドが用意されれば完了です。

索引モデルが issue の本文から書いたものです。

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
20/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。