From dec6df15c743fa18df2986950934768b063d3ccb Mon Sep 17 00:00:00 2001 From: Bob Mader Date: Mon, 4 Dec 2023 08:52:01 -0600 Subject: [PATCH] Fix docs and links (#29) * minor doc fixes * fix github links --- .github/workflows/release.yml | 6 +++--- CONTRIBUTING.md | 2 +- README.md | 10 ++++------ galaxy.yml | 8 ++++---- roles/initramfs/README.md | 2 +- 5 files changed, 13 insertions(+), 15 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0caad0e..1bdcb36 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -8,11 +8,11 @@ on: jobs: ansible-lint: - uses: swapdisk/lvm_snapshots/.github/workflows/ansible-lint.yml@main + uses: swapdisk/infra.lvm_snapshots/.github/workflows/ansible-lint.yml@main pylint: - uses: swapdisk/lvm_snapshots/.github/workflows/pylint.yml@main + uses: swapdisk/infra.lvm_snapshots/.github/workflows/pylint.yml@main shellcheck: - uses: swapdisk/lvm_snapshots/.github/workflows/shellcheck.yml@main + uses: swapdisk/infra.lvm_snapshots/.github/workflows/shellcheck.yml@main prechecks: needs: - ansible-lint diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bf85287..ec1d2f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,4 +2,4 @@ Thank you for your interest in contributing to the LVM Snapshots Collection. All we ask is that contributors please observe the [Ansible Community Guidelines](https://docs.ansible.com/ansible/devel/community/index.html) and follow the [Ansible Collections Contributor Guide](https://docs.ansible.com/ansible/devel/community/contributions_collections.html). We look forward to reviewing your pull request. -Everyone is invited to participate. We welcome first timers as well as experienced open source contributors. If you are unsure how to get started with your contributon, open a [new issue](https://github.com/swapdisk/lvm_snapshots/issues/new/choose) explaining what you want to do and we'll do our best to help! +Everyone is invited to participate. We welcome first timers as well as experienced open source contributors. If you are unsure how to get started with your contributon, open a [new issue](https://github.com/swapdisk/infra.lvm_snapshots/issues/new/choose) explaining what you want to do and we'll do our best to help! diff --git a/README.md b/README.md index e94e9bd..d3cacd5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # LVM Snapshots Collection -[![Ansible Lint](https://github.com/swapdisk/lvm_snapshots/workflows/Ansible%20Lint/badge.svg?event=push)](https://github.com/swapdisk/lvm_snapshots/actions) [![PyLint](https://github.com/swapdisk/lvm_snapshots/workflows/PyLint/badge.svg?event=push)](https://github.com/swapdisk/lvm_snapshots/actions) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8141/badge)](https://www.bestpractices.dev/projects/8141) +[![Ansible Lint](https://github.com/swapdisk/infra.lvm_snapshots/workflows/Ansible%20Lint/badge.svg?event=push)](https://github.com/swapdisk/infra.lvm_snapshots/actions) [![PyLint](https://github.com/swapdisk/infra.lvm_snapshots/workflows/PyLint/badge.svg?event=push)](https://github.com/swapdisk/infra.lvm_snapshots/actions) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8141/badge)](https://www.bestpractices.dev/projects/8141) ## Overview @@ -11,11 +11,9 @@ A reliable snapshot/rollback capability is a key feature required to enable the These are the roles included in the collection. Follow the links below to see the detailed documentation and example playbooks for each role. - [`lvm_snapshots`](./roles/lvm_snapshots/) - controls creation and rollback for a defined set of LVM snapshot volumes +- [`shrink_lv`](./roles/shrink_lv/) - controls decreasing logical volume size along with the filesystem - [`bigboot`](./roles/bigboot/) - controls increasing of the boot partition while moving, and shrinking if needed, the adjacent partition - [`initramfs`](./roles/initramfs/) - controls the atomic flow of building and using a temporary initramfs in a reboot and restoring the original one -- [`shrink_lv`](./roles/shrink_lv/) - controls decreasing logical volume size along with the filesystem - -Additional roles are planned to support shrinking logical volumes to make free space available in a volume group and relocating physical volumes to enable increasing the size of a /boot /partition. ## Installing the collection from Ansible Galaxy @@ -53,7 +51,7 @@ We appreciate participation from any new contributors. Get started by opening an ## Reporting issues -Please open a [new issue](https://github.com/swapdisk/lvm_snapshots/issues/new/choose) for any bugs or security vulnerabilities you may encounter. We also invite you to open an issue if you have ideas on how we can improve the solution or want to make a suggestion for enhancement. +Please open a [new issue](https://github.com/swapdisk/infra.lvm_snapshots/issues/new/choose) for any bugs or security vulnerabilities you may encounter. We also invite you to open an issue if you have ideas on how we can improve the solution or want to make a suggestion for enhancement. ## More information @@ -61,7 +59,7 @@ This collection is just one building block of our larger initiative to make RHEL ## Release notes -See the [changelog](https://github.com/swapdisk/lvm_snapshots/tree/main/CHANGELOG.rst). +See the [changelog](https://github.com/swapdisk/infra.lvm_snapshots/tree/main/CHANGELOG.rst). ## Licensing diff --git a/galaxy.yml b/galaxy.yml index 5b01861..743a43f 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -14,10 +14,10 @@ tags: - storage dependencies: "community.general": "*" -repository: https://github.com/swapdisk/lvm_snapshots -documentation: https://github.com/swapdisk/lvm_snapshots -homepage: https://github.com/swapdisk/lvm_snapshots -issues: https://github.com/swapdisk/lvm_snapshots/issues +repository: https://github.com/swapdisk/infra.lvm_snapshots +documentation: https://github.com/swapdisk/infra.lvm_snapshots +homepage: https://github.com/swapdisk/infra.lvm_snapshots +issues: https://github.com/swapdisk/infra.lvm_snapshots/issues build_ignore: - .ansible-lint - .pylintrc diff --git a/roles/initramfs/README.md b/roles/initramfs/README.md index 01d41a6..f724096 100644 --- a/roles/initramfs/README.md +++ b/roles/initramfs/README.md @@ -1,6 +1,6 @@ # initramfs -The `initramfs` role is used to run an atomic flow of building and using a temporary initramfs in a reboot and restoring the original one. +The `initramfs` role is included by the `shrink_lv` and `bigboot` roles to run an atomic flow of building and using a temporary initramfs in a reboot and restoring the original one. The role is designed to be internal for this collection and support the automation of RHEL in-place upgrades, but can also be used for other purposes.