From 2c48e2a01f5f7a7fb1bb75e5e756d2e2b5a927ea Mon Sep 17 00:00:00 2001 From: Ben Parizek Date: Fri, 21 Jun 2019 23:38:16 -0400 Subject: [PATCH] Updates URLs and community files --- .github/CODE_OF_CONDUCT.md | 4 ++ .github/CONTRIBUTING.md | 3 + .github/ISSUE_TEMPLATE | 15 ----- .github/ISSUE_TEMPLATE/bug-report.md | 26 ++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 15 +++++ .github/SECURITY.md | 3 + .github/SUPPORT.md | 3 + README.md | 79 ++--------------------- composer.json | 7 +- 9 files changed, 61 insertions(+), 94 deletions(-) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md delete mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/SECURITY.md create mode 100644 .github/SUPPORT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..25ab1bb --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,4 @@ +# Code of Conduct + +We ask our users to respect the [Code of Conduct](https://docs.craftcms.com/v3/coc.html) of the greater Craft community. + diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..b05a597 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing to Sprout Plugins + +Please see the [Contributing](https://sprout.barrelstrengthdesign.com/docs/contributing.html) page in our documentation for details on contributing to Sprout Plugins. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE deleted file mode 100644 index 4208833..0000000 --- a/.github/ISSUE_TEMPLATE +++ /dev/null @@ -1,15 +0,0 @@ -### Description - - - -### Steps to reproduce - -1. -2. - -### Additional info - -- Craft version: -- PHP version: -- Database driver & version: -- Plugins & versions: \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 0000000..ea8f700 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,26 @@ +--- +name: Bug report +about: Tell us about a bug you may have identified +--- + +### Description (screenshots, logs, ...) + + + +### Steps to reproduce + +1. +2. + +### Additional info + +- Craft version: +- PHP version: +- Database driver & version: +- Plugins & versions: + +_For some issues, we may request that you send the following items to Support . If you feel your issue may fall in that category, feel free to send things over after you post this issue and reference the issue in your email._ + +- `composer.json` +- `storage/logs/web.log` (or a zip of the whole log folder) +- An export of your database (or, if you can't share the whole db, the specific Sprout tables) diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 0000000..e5020e2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,15 @@ +--- +name: Feature request +about: Suggest an idea for a new feature +--- + +### The problem (description, use case, screenshots...) + + + +### The solution (that feature you'd like to see) + + + +### Alternatives you've considered + diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..f69d3f4 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,3 @@ +# Security Policy + +Please see the [Security](https://sprout.barrelstrengthdesign.com/docs/support/security.html) page in our documentation for details on our security policy and reporting security issues. \ No newline at end of file diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 0000000..4cecc7e --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,3 @@ +# Support + +Please see the [Support](https://sprout.barrelstrengthdesign.com/docs/support/support.html) page in our documentation for details on receiving support. \ No newline at end of file diff --git a/README.md b/README.md index 3eff9ab..b2ea073 100644 --- a/README.md +++ b/README.md @@ -4,80 +4,11 @@ Allow users to subscribe to, follow, or like any Element including Entries, Cate Use Sprout Lists with Sprout Email for powerful email list management and dynamic notification emails. -## Usage - -Example Subscribe and Unsubscribe for Craft Users with a User ID: - -``` twig -{% set params = { - listHandle: 'listHandle', - userId: currentUser.id, - elementId: entry.id, -} %} - -{# Check if a user is subscribed already #} -{% if craft.sproutLists.isSubscribed(params) %} - - {# Unsubscribe a user from a specific List #} -
- {{ csrfInput() }} - - - - - -
- -{% else %} - - {# Subscribe a user to a specific List #} -
- {{ csrfInput() }} - - - - - -
- -{% endif %} -``` - -Example Subscribe and Unsubscribe for Guests using an email address: - -``` twig -{# Allow a user to submit their email to unsubscribe from a specific List #} -
- {{ csrfInput() }} - - - - - -
- -{# Allow a user to submit their email to subscribe from a specific List #} -
- {{ csrfInput() }} - - - - - -
-``` - -See the documentation for additional template tags and use cases. - -## Documentation - -See the [Sprout Website](https://sprout.barrelstrengthdesign.com/craft-plugins/lists/docs) for documentation, guides, and additional resources. - -## Support - -- [Send a Support Ticket](https://sprout.barrelstrengthdesign.com/craft-plugins/request/support) via the Sprout Website. -- [Create an issue](https://github.com/barrelstrength/craft-sprout-lists/issues) on Github. +- [Documentation](https://sprout.barrelstrengthdesign.com/docs/lists/) +- [Craft Plugin Store](https://plugins.craftcms.com/sprout-lists) +- [Open an Issue](https://github.com/barrelstrength/craft-sprout-lists/issues) +- [Contact Support](https://sprout.barrelstrengthdesign.com/docs/support/support.html) - + \ No newline at end of file diff --git a/composer.json b/composer.json index 1434ad3..5317f8a 100644 --- a/composer.json +++ b/composer.json @@ -21,7 +21,7 @@ "email": "sprout@barrelstrengthdesign.com", "issues": "https://github.com/barrelstrength/sprout-lists/issues?state=open", "source": "https://github.com/barrelstrength/sprout-lists", - "docs": "https://sprout.barrelstrengthdesign.com/craft-plugins/email/docs", + "docs": "https://sprout.barrelstrengthdesign.com/docs/lists", "rss": "https://github.com/barrelstrength/sprout-lists/commits/v2.atom" }, "require": { @@ -38,10 +38,7 @@ "name": "Sprout Lists", "handle": "sprout-lists", "developer": "Barrel Strength", - "developerUrl": "https://barrelstrengthdesign.com", - "documentationUrl": "https://sprout.barrelstrengthdesign.com/craft-plugins/lists", - "changelogUrl": "https://raw.githubusercontent.com/BarrelStrength/sprout-lists/master/CHANGELOG.md", - "downloadUrl": "https://github.com/BarrelStrength/sprout-lists/archive/master.zip", + "documentationUrl": "https://sprout.barrelstrengthdesign.com/docs/lists", "class": "barrelstrength\\sproutlists\\SproutLists" } }