From 1ff69e0d4e69681938f58da0b3203345f6eeaf62 Mon Sep 17 00:00:00 2001 From: Richard Laager Date: Fri, 22 May 2020 16:48:23 -0500 Subject: [PATCH] Debian/Ubuntu: Update Contributing docs The Contributing docs needed updating after the move to Sphinx. Signed-off-by: Richard Laager --- .../Debian/Debian Buster Root on ZFS.rst | 34 ++++++++++++++----- .../Debian/Debian Stretch Root on ZFS.rst | 34 ++++++++++++++----- .../Ubuntu/Ubuntu 16.04 Root on ZFS.rst | 30 ++++++++++++++++ .../Ubuntu/Ubuntu 18.04 Root on ZFS.rst | 34 ++++++++++++++----- 4 files changed, 105 insertions(+), 27 deletions(-) diff --git a/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst b/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst index 8915565..de77a38 100644 --- a/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst +++ b/docs/Getting Started/Debian/Debian Buster Root on ZFS.rst @@ -42,16 +42,32 @@ mention @rlaager. Contributing ------------ -Edit permission on this wiki is restricted. Also, GitHub wikis do not -support pull requests. However, you can clone the wiki using git. +1) Fork and clone: https://github.com/openzfs/openzfs-docs -1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` -2) Make your changes. -3) Use ``git diff > my-changes.patch`` to create a patch. (Advanced git - users may wish to ``git commit`` to a branch and - ``git format-patch``.) -4) `File a new issue `__, - mention @rlaager, and attach the patch. +2) Install the tools: + +:: + + # On Debian 11 / Ubuntu 20.04 or later: + sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme + # On earlier releases: + sudo apt install pip3 + pip3 install -r requirements.txt + # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc: + PATH=$HOME/.local/bin:$PATH + +3) Make your changes. + +4) Test: + +:: + + cd docs + make html + sensible-browser _build/html/index.html + +5) ``git commit --signoff`` to a branch, ``git push``, and create a pull request. + Mention @rlaager. Encryption ---------- diff --git a/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst b/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst index 215c034..23c5e14 100644 --- a/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst +++ b/docs/Getting Started/Debian/Debian Stretch Root on ZFS.rst @@ -47,16 +47,32 @@ mention @rlaager. Contributing ------------ -Edit permission on this wiki is restricted. Also, GitHub wikis do not -support pull requests. However, you can clone the wiki using git. +1) Fork and clone: https://github.com/openzfs/openzfs-docs -1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` -2) Make your changes. -3) Use ``git diff > my-changes.patch`` to create a patch. (Advanced git - users may wish to ``git commit`` to a branch and - ``git format-patch``.) -4) `File a new issue `__, - mention @rlaager, and attach the patch. +2) Install the tools: + +:: + + # On Debian 11 / Ubuntu 20.04 or later: + sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme + # On earlier releases: + sudo apt install pip3 + pip3 install -r requirements.txt + # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc: + PATH=$HOME/.local/bin:$PATH + +3) Make your changes. + +4) Test: + +:: + + cd docs + make html + sensible-browser _build/html/index.html + +5) ``git commit --signoff`` to a branch, ``git push``, and create a pull request. + Mention @rlaager. Encryption ---------- diff --git a/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst b/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst index cc6ca81..23cac48 100644 --- a/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst +++ b/docs/Getting Started/Ubuntu/Ubuntu 16.04 Root on ZFS.rst @@ -44,6 +44,36 @@ have a bug report or feature request related to this HOWTO, please `file a new issue `__ and mention @rlaager. +Contributing +------------ + +1) Fork and clone: https://github.com/openzfs/openzfs-docs + +2) Install the tools: + +:: + + # On Debian 11 / Ubuntu 20.04 or later: + sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme + # On earlier releases: + sudo apt install pip3 + pip3 install -r requirements.txt + # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc: + PATH=$HOME/.local/bin:$PATH + +3) Make your changes. + +4) Test: + +:: + + cd docs + make html + sensible-browser _build/html/index.html + +5) ``git commit --signoff`` to a branch, ``git push``, and create a pull request. + Mention @rlaager. + Encryption ---------- diff --git a/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst b/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst index adfde07..a5e3639 100644 --- a/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst +++ b/docs/Getting Started/Ubuntu/Ubuntu 18.04 Root on ZFS.rst @@ -41,16 +41,32 @@ mention @rlaager. Contributing ------------ -Edit permission on this wiki is restricted. Also, GitHub wikis do not -support pull requests. However, you can clone the wiki using git. +1) Fork and clone: https://github.com/openzfs/openzfs-docs -1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` -2) Make your changes. -3) Use ``git diff > my-changes.patch`` to create a patch. (Advanced git - users may wish to ``git commit`` to a branch and - ``git format-patch``.) -4) `File a new issue `__, - mention @rlaager, and attach the patch. +2) Install the tools: + +:: + + # On Debian 11 / Ubuntu 20.04 or later: + sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme + # On earlier releases: + sudo apt install pip3 + pip3 install -r requirements.txt + # Add ~/.local/bin to your $PATH, e.g. by adding this to ~/.bashrc: + PATH=$HOME/.local/bin:$PATH + +3) Make your changes. + +4) Test: + +:: + + cd docs + make html + sensible-browser _build/html/index.html + +5) ``git commit --signoff`` to a branch, ``git push``, and create a pull request. + Mention @rlaager. Encryption ----------