forked from fsulib/embargoes
-
Notifications
You must be signed in to change notification settings - Fork 7
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
update readme, fix issues #5
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,62 @@ | ||
# Embargoes | ||
Drupal 8 module for managing embargo policies with access restrictions on content | ||
|
||
# Introduction | ||
|
||
Adds the ability to manage embargo policies with access restrictions on content. | ||
|
||
## Requirements | ||
Embargoes requires no other Drupal modules to work. | ||
|
||
This module requires the following modules/libraries: | ||
|
||
* [Menu UI](https://www.drupal.org/docs/core-modules-and-themes/core-modules/menu-ui-module) | ||
|
||
## Installation | ||
|
||
Install as | ||
[usual](https://www.drupal.org/docs/8/extending-drupal-8/installing-drupal-8-modules). | ||
|
||
## Configuration | ||
|
||
Configuration options can be set at `admin/config/content/embargoes/settings`, | ||
including notification options and IP range settings that can apply to | ||
embargoes. | ||
|
||
To add an IP range for use on embargoes, navigate to | ||
`admin/config/content/embargoes/settings/ips` and click 'Add IP range'. Ranges | ||
created via this method can then be used as IP address whitelists when creating | ||
embargoes. | ||
|
||
## Usage | ||
|
||
### Applying an embargo | ||
|
||
An embargo can be applied to an existing node by navigating to | ||
`node/{node_id/embargoes`. From here, an embargo can be applied if it doesn't | ||
already exist, and existing embargoes can be modified or removed. | ||
|
||
### Logging | ||
|
||
Embargo logs are kept at `admin/config/content/embargoes/settings/log`, | ||
including who created the embargo, or how it was changed. | ||
|
||
## Troubleshooting/Issues | ||
|
||
Having problems or solved one? Contact | ||
[discoverygarden](http://support.discoverygarden.ca). | ||
|
||
## Maintainers/Sponsors | ||
|
||
Current maintainers: | ||
|
||
* [discoverygarden](http://www.discoverygarden.ca) | ||
|
||
## Development | ||
|
||
If you would like to contribute to this module, please check out the helpful | ||
[Documentation](https://github.com/Islandora/islandora/wiki#wiki-documentation-for-developers), | ||
[Developers](http://islandora.ca/developers) section on Islandora.ca and create | ||
an issue, pull request and or contact | ||
[discoverygarden](http://support.discoverygarden.ca). | ||
|
||
## License | ||
[GPLv2](http://www.gnu.org/licenses/gpl-2.0.txt) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing a closing brace after
{node_id