Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand the README with detailed descriptions and usage instructions for each script #15

Merged
merged 1 commit into from
Dec 15, 2024

Conversation

obscurerichard
Copy link
Member

@obscurerichard obscurerichard commented Dec 15, 2024

Expand the README.md with headings for each of the linked scripts, with an expanded description of what the scripts do and what the usage instructions are.

  • blockip.sh

    • Add heading and description.
    • Add usage instructions.
  • btidy.sh

    • Add heading and description.
    • Add usage instructions.
  • cloud-init-centos-7-ipv6.yml

    • Add heading and description.
    • Add usage instructions.
  • icinga2-graceful.sh

    • Add heading and description.
    • Add usage instructions.
  • icinga2-watchdog.sh

    • Add heading and description.
    • Add usage instructions.
  • imapd-reap-processes.sh

    • Add heading and description.
    • Add usage instructions.
  • patronus.sh

    • Add heading and description.
    • Add usage instructions.
  • run-sysbench.sh

    • Add heading and description.
    • Add usage instructions.
  • ssh-add-all.sh

    • Add heading and description.
    • Add usage instructions.
  • ssh-add-ramdisk.sh

    • Add heading and description.
    • Add usage instructions.
  • ssh-env.sh

    • Add heading and description.
    • Add usage instructions.
  • uptimerobot-firewall-update.sh

    • Add heading and description.
    • Add usage instructions.
  • tiamat-setup.sh

    • Add heading and description.
    • Add usage instructions.
  • watch-filevault-setup.sh

    • Add heading and description.
    • Add usage instructions.

For more details, open the Copilot Workspace session.

…or each script

Expand the `README.md` with headings for each of the linked scripts, with an expanded description of what the scripts do and what the usage instructions are.

* **blockip.sh**
  - Add heading and description.
  - Add usage instructions.

* **btidy.sh**
  - Add heading and description.
  - Add usage instructions.

* **cloud-init-centos-7-ipv6.yml**
  - Add heading and description.
  - Add usage instructions.

* **icinga2-graceful.sh**
  - Add heading and description.
  - Add usage instructions.

* **icinga2-watchdog.sh**
  - Add heading and description.
  - Add usage instructions.

* **imapd-reap-processes.sh**
  - Add heading and description.
  - Add usage instructions.

* **patronus.sh**
  - Add heading and description.
  - Add usage instructions.

* **run-sysbench.sh**
  - Add heading and description.
  - Add usage instructions.

* **ssh-add-all.sh**
  - Add heading and description.
  - Add usage instructions.

* **ssh-add-ramdisk.sh**
  - Add heading and description.
  - Add usage instructions.

* **ssh-env.sh**
  - Add heading and description.
  - Add usage instructions.

* **uptimerobot-firewall-update.sh**
  - Add heading and description.
  - Add usage instructions.

* **tiamat-setup.sh**
  - Add heading and description.
  - Add usage instructions.

* **watch-filevault-setup.sh**
  - Add heading and description.
  - Add usage instructions.

---

For more details, open the [Copilot Workspace session](https://copilot-workspace.githubnext.com/obscureorganization/obscure-scripts?shareId=XXXX-XXXX-XXXX-XXXX).
@obscurerichard obscurerichard merged commit 96b9e10 into main Dec 15, 2024
1 check passed
@obscurerichard obscurerichard deleted the obscurerichard/expand-readme branch December 15, 2024 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant