Debian/Ubuntu: Update Contributing docs

The Contributing docs needed updating after the move to Sphinx.

Signed-off-by: Richard Laager <rlaager@wiktel.com>
This commit is contained in:
Richard Laager
2020-05-22 16:48:23 -05:00
parent 5140c6caa3
commit 1ff69e0d4e
4 changed files with 105 additions and 27 deletions

View File

@@ -42,16 +42,32 @@ mention @rlaager.
Contributing Contributing
------------ ------------
Edit permission on this wiki is restricted. Also, GitHub wikis do not 1) Fork and clone: https://github.com/openzfs/openzfs-docs
support pull requests. However, you can clone the wiki using git.
1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` 2) Install the tools:
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``.) # On Debian 11 / Ubuntu 20.04 or later:
4) `File a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__, sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme
mention @rlaager, and attach the patch. # 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 Encryption
---------- ----------

View File

@@ -47,16 +47,32 @@ mention @rlaager.
Contributing Contributing
------------ ------------
Edit permission on this wiki is restricted. Also, GitHub wikis do not 1) Fork and clone: https://github.com/openzfs/openzfs-docs
support pull requests. However, you can clone the wiki using git.
1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` 2) Install the tools:
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``.) # On Debian 11 / Ubuntu 20.04 or later:
4) `File a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__, sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme
mention @rlaager, and attach the patch. # 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 Encryption
---------- ----------

View File

@@ -44,6 +44,36 @@ have a bug report or feature request related to this HOWTO, please `file
a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__ and
mention @rlaager. 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 Encryption
---------- ----------

View File

@@ -41,16 +41,32 @@ mention @rlaager.
Contributing Contributing
------------ ------------
Edit permission on this wiki is restricted. Also, GitHub wikis do not 1) Fork and clone: https://github.com/openzfs/openzfs-docs
support pull requests. However, you can clone the wiki using git.
1) ``git clone https://github.com/zfsonlinux/zfs.wiki.git`` 2) Install the tools:
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``.) # On Debian 11 / Ubuntu 20.04 or later:
4) `File a new issue <https://github.com/zfsonlinux/zfs/issues/new>`__, sudo apt install python3-sphinx python3-sphinx-issues python3-sphinx-rtd-theme
mention @rlaager, and attach the patch. # 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 Encryption
---------- ----------