Skip to content

Commit d28c2aa

Browse files
committed
Docs: Updates notes around submitting issues
1 parent 2476e29 commit d28c2aa

File tree

5 files changed

+29
-8
lines changed

5 files changed

+29
-8
lines changed

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Contributor Code of Conduct
22

3-
This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters.
3+
This project adheres to No Code of Conduct. We are all adults. We accept anyone's contributions. Nothing else matters.
44

55
For more information please visit the [No Code of Conduct](https://github.com/domgetter/NCoC) homepage.

CONTRIBUTING.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,24 @@
22

33
## Submitting issues
44

5-
Please don't be scared to raise issues that you find while using this module, but please be sure to perform a quick search through open and closed ticket to see if the same (or similar) issue has already been raised. If you find an existing issue that has been closed, feel free to raise a new issue referencing the old, or you can request that the existing ticket be reopened.
5+
Please don't be scared to raise issues that you find while using this module, but please be sure to perform a quick
6+
search through open and closed ticket to see if the same (or similar) issue has already been raised. If you find an
7+
existing issue that has been closed, feel free to raise a new issue referencing the old, or you can request that the
8+
existing ticket be reopened.
69

710
[Raise an issue](https://github.com/silverstripe-terraformers/silverstripe-embargo-expiry/issues)
811

12+
### What to include
13+
14+
Please consider adding the following information to your issue:
15+
16+
* What version of E&E is your project using?
17+
* What version of `silverstripe/framework` is your project using?
18+
* How are you using E&E? EG: Is E&E applied to your page, or is it applied to (say) the Blocks on the page?
19+
* Steps to reproduce the issue (ideally including screenshots of each step you take)
20+
* Any other modules that you believe could be interacting with E&E to cause the issue
21+
922
## Contributing code
1023

11-
Please try your best to conform to PHPCS coding standard. We won't get mad if you don't, but it will make your pull requests go a lot faster.
24+
Please try your best to conform to PHPCS coding standard. We won't get mad if you don't, but it will make your pull
25+
requests go a lot faster.

docs/en/configuration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
## Allow/disallow editing of content while an Embargo date is set
44

5-
When a `PublishTargetJob` is run, it will publish whatever the current draft state is. In your project, you might want to allow or disallow the editing of content once an Embargo date is set. Disallowing editing of content will mean that once an Embargo date is set, you'll know that no additional changes have been made to the record.
5+
When a `PublishTargetJob` is run, it will publish whatever the current draft state is. In your project, you might want
6+
to allow or disallow the editing of content once an Embargo date is set. Disallowing editing of content will mean that
7+
once an Embargo date is set, you'll know that no additional changes have been made to the record.
68

79
By default, editing while an Embargo date is set is **enabled**.
810

@@ -20,7 +22,9 @@ My\Awesome\DataObject:
2022

2123
## Enforce sequential Embargo and Expiry dates
2224

23-
When setting an Embargo and Expiry date, you may wish to allow or disallow users setting an Expiry date that is **prior** to the Embargo date. Allowing a user to have dates in either order could be useful if they have a use case for un-publishing an already published page for a small window of time before it is automatically published again.
25+
When setting an Embargo and Expiry date, you may wish to allow or disallow users setting an Expiry date that is
26+
**prior** to the Embargo date. Allowing a user to have dates in either order could be useful if they have a use case for
27+
un-publishing an already published page for a small window of time before it is automatically published again.
2428

2529
By default, sequential dates are **not** enforced (Expiry dates can be for earlier than the Embargo date).
2630

docs/en/fluent-support.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@
44

55
`EmbargoExpiryFluentExtension` is provided to add support for DataObject that have `FluentVersionedExtension` applied.
66

7-
The expected behaviour is that you can now set an Embargo & Expiry date in each Locale separately from each other, and when those dates pass, the Jobs will publish/un-publish only the record in that Locale.
7+
The expected behaviour is that you can now set an Embargo & Expiry date in each Locale separately from each other, and
8+
when those dates pass, the Jobs will publish/un-publish only the record in that Locale.

docs/en/installation.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ SilverStripe\CMS\Model\SiteTree:
1414
- Terraformers\EmbargoExpiry\Extension\EmbargoExpiryExtension
1515
```
1616
17-
If you are applying the extension fo a DataObject other than `SiteTree`, ensure it has the `Versioned` extension applied so it can be published/unpublished.
17+
If you are applying the extension fo a DataObject other than `SiteTree`, ensure it has the `Versioned` extension applied
18+
so it can be published/unpublished.
1819

1920
```yml
2021
MyCustomDataObject:
@@ -25,6 +26,7 @@ MyCustomDataObject:
2526

2627
Now run a `dev/build?flush=all` in your browser, or from the command line via `vendor/bin/sake dev/build flush=all`.
2728

28-
Finally, ensure you've set up [queuedjobs](https://github.com/symbiote/silverstripe-queuedjobs) correctly to execute your jobs periodically.
29+
Finally, ensure you've set up [queuedjobs](https://github.com/symbiote/silverstripe-queuedjobs) correctly to execute
30+
your jobs periodically.
2931

3032
For more information please see [configuration](configuration.md).

0 commit comments

Comments
 (0)