# Salt Extension for ZFS
Salt Extension for interacting with ZFS
## Security
If you discover a security vulnerability, please refer
to [Salt's security guide][security].
## User Documentation
For setup and usage instructions, please refer to the
[User Documentation][docs].
## Contributing
The saltext-zfs project welcomes contributions from anyone!
The [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects
of Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],
[writing documentation][writing-docs] and [rendering the docs][rendering-docs].
### Quickstart
To get started contributing, first clone this repository (or your fork):
```bash
# Clone the repo
git clone --origin upstream git@github.com:salt-extensions/saltext-zfs.git
# Change to the repo dir
cd saltext-zfs
```
#### Automatic
If you have installed [direnv][direnv], allowing the project's `.envrc` ensures
a proper development environment is present and the virtual environment is active.
Without `direnv`, you can still run the automation explicitly:
```bash
python3 tools/initialize.py
source .venv/bin/activate
```
#### Manual
Please follow the [first steps][first-steps], skipping the repository initialization and first commit.
### Pull request
Always make changes in a feature branch:
```bash
git switch -c my-feature-branch
```
To [submit a Pull Request][submitting-pr], you'll need a fork of this repository in
your own GitHub account. If you followed the instructions above,
set your fork as the `origin` remote now:
```bash
git remote add origin git@github.com:<your_fork>.git
```
Ensure you followed the [first steps][first-steps] and commit your changes, fixing any
failing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.
### Ways to contribute
Contributions come in many forms, and they’re all valuable! Here are some ways you can help
without writing code:
* **Documentation**: Especially examples showing how to use this project
to solve specific problems.
* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].
* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].
You can also contribute by:
* Writing blog posts
* Sharing your experiences using Salt + ZFS
on social media
* Giving talks at conferences
* Publishing videos
* Engaging in IRC, Discord or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/
[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html
[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html
[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html
[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html
[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment
[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork
[direnv]: https://direnv.net
[issues]: https://github.com/salt-extensions/saltext-zfs/issues
[PRs]: https://github.com/salt-extensions/saltext-zfs/pulls
[discussions]: https://github.com/salt-extensions/saltext-zfs/discussions
[comments]: https://conventionalcomments.org/
[docs]: https://salt-extensions.github.io/saltext-zfs/
Raw data
{
"_id": null,
"home_page": null,
"name": "saltext.zfs",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "salt-extension",
"author": null,
"author_email": "jeanluc <lkubb@protonmail.com>, Jorge Schrauwen <sjorge@blackdot.be>, Nitin Madhok <nmadhok@g.clemson.edu>",
"download_url": "https://files.pythonhosted.org/packages/7b/59/ee590aade9b3738b69b5aa280a8f9055000f3a65afb72994783489d36638/saltext_zfs-1.0.0.tar.gz",
"platform": "any",
"description": "# Salt Extension for ZFS\n\nSalt Extension for interacting with ZFS\n\n## Security\n\nIf you discover a security vulnerability, please refer\nto [Salt's security guide][security].\n\n## User Documentation\n\nFor setup and usage instructions, please refer to the\n[User Documentation][docs].\n\n## Contributing\n\nThe saltext-zfs project welcomes contributions from anyone!\n\nThe [Salt Extensions guide][salt-extensions-guide] provides comprehensive instructions on all aspects\nof Salt extension development, including [writing tests][writing-tests], [running tests][running-tests],\n[writing documentation][writing-docs] and [rendering the docs][rendering-docs].\n\n### Quickstart\n\nTo get started contributing, first clone this repository (or your fork):\n\n```bash\n# Clone the repo\ngit clone --origin upstream git@github.com:salt-extensions/saltext-zfs.git\n\n# Change to the repo dir\ncd saltext-zfs\n```\n\n#### Automatic\nIf you have installed [direnv][direnv], allowing the project's `.envrc` ensures\na proper development environment is present and the virtual environment is active.\n\nWithout `direnv`, you can still run the automation explicitly:\n\n```bash\npython3 tools/initialize.py\nsource .venv/bin/activate\n```\n\n#### Manual\nPlease follow the [first steps][first-steps], skipping the repository initialization and first commit.\n\n### Pull request\n\nAlways make changes in a feature branch:\n\n```bash\ngit switch -c my-feature-branch\n```\n\nTo [submit a Pull Request][submitting-pr], you'll need a fork of this repository in\nyour own GitHub account. If you followed the instructions above,\nset your fork as the `origin` remote now:\n\n```bash\ngit remote add origin git@github.com:<your_fork>.git\n```\n\nEnsure you followed the [first steps][first-steps] and commit your changes, fixing any\nfailing `pre-commit` hooks. Then push the feature branch to your fork and submit a PR.\n\n### Ways to contribute\n\nContributions come in many forms, and they\u2019re all valuable! Here are some ways you can help\nwithout writing code:\n\n* **Documentation**: Especially examples showing how to use this project\n to solve specific problems.\n* **Triaging issues**: Help manage [issues][issues] and participate in [discussions][discussions].\n* **Reviewing [Pull Requests][PRs]**: We especially appreciate reviews using [Conventional Comments][comments].\n\nYou can also contribute by:\n\n* Writing blog posts\n* Sharing your experiences using Salt + ZFS\n on social media\n* Giving talks at conferences\n* Publishing videos\n* Engaging in IRC, Discord or email groups\n\nAny of these things are super valuable to our community, and we sincerely\nappreciate every contribution!\n\n[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md\n[salt-extensions-guide]: https://salt-extensions.github.io/salt-extension-copier/\n[writing-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/writing.html\n[running-tests]: https://salt-extensions.github.io/salt-extension-copier/topics/testing/running.html\n[writing-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/writing.html\n[rendering-docs]: https://salt-extensions.github.io/salt-extension-copier/topics/documenting/building.html\n[first-steps]: https://salt-extensions.github.io/salt-extension-copier/topics/creation.html#initialize-the-python-virtual-environment\n[submitting-pr]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork\n[direnv]: https://direnv.net\n[issues]: https://github.com/salt-extensions/saltext-zfs/issues\n[PRs]: https://github.com/salt-extensions/saltext-zfs/pulls\n[discussions]: https://github.com/salt-extensions/saltext-zfs/discussions\n[comments]: https://conventionalcomments.org/\n[docs]: https://salt-extensions.github.io/saltext-zfs/\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Extension for interacting with ZFS",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://salt-extensions.github.io/saltext-zfs/",
"Homepage": "https://github.com/salt-extensions/saltext-zfs",
"Source": "https://github.com/salt-extensions/saltext-zfs",
"Tracker": "https://github.com/salt-extensions/saltext-zfs/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bde2d80a28830eff81f9dbbafe51da8ec2494c6e7029c64147d86dc382b12b1",
"md5": "f2e879a1a14c6efc25dcb9bc0d001fe5",
"sha256": "433b70f5e9a280eab5bb1e41466ec624080c22dca8549b9bef14d607ea04f496"
},
"downloads": -1,
"filename": "saltext.zfs-1.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "f2e879a1a14c6efc25dcb9bc0d001fe5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 39692,
"upload_time": "2024-09-28T08:46:54",
"upload_time_iso_8601": "2024-09-28T08:46:54.300256Z",
"url": "https://files.pythonhosted.org/packages/6b/de/2d80a28830eff81f9dbbafe51da8ec2494c6e7029c64147d86dc382b12b1/saltext.zfs-1.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7b59ee590aade9b3738b69b5aa280a8f9055000f3a65afb72994783489d36638",
"md5": "99f8965ce8afd9f279a660542a293c4a",
"sha256": "fe6eb92d698a9d76cfce77daadefee6c5e3f89b0b0effefdf244d8258cc5d08d"
},
"downloads": -1,
"filename": "saltext_zfs-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "99f8965ce8afd9f279a660542a293c4a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 93595,
"upload_time": "2024-09-28T08:46:55",
"upload_time_iso_8601": "2024-09-28T08:46:55.884067Z",
"url": "https://files.pythonhosted.org/packages/7b/59/ee590aade9b3738b69b5aa280a8f9055000f3a65afb72994783489d36638/saltext_zfs-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-28 08:46:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "salt-extensions",
"github_project": "saltext-zfs",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "saltext.zfs"
}
JSON
