Skip to content

Commit

Permalink
[FIX] Cleanup markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredhowland committed Feb 5, 2019
1 parent 5e96dd1 commit f2295ea
Show file tree
Hide file tree
Showing 5 changed files with 54 additions and 60 deletions.
3 changes: 0 additions & 3 deletions .scrutinizer.yml
@@ -1,7 +1,4 @@
build:
dependencies:
before:
- composer install --no-dev
nodes:
analysis:
project_setup:
Expand Down
23 changes: 10 additions & 13 deletions CODE_OF_CONDUCT.md
Expand Up @@ -14,22 +14,19 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Expand Up @@ -7,16 +7,16 @@ We accept contributions via Pull Requests on [Github](https://github.com/hbll-co

## Pull Requests

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.

- **Document any change in behavior** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Document any change in behavior** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.
- **Create feature branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
16 changes: 8 additions & 8 deletions PULL_REQUEST_TEMPLATE.md
Expand Up @@ -23,20 +23,20 @@ see how your change affects other areas of the code, etc.
## Types of changes

What types of changes does your code introduce? Put an `x` in all the boxes that apply:
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:

Go over all the following points, and put an `x` in all the boxes that apply.

Please, please, please, don't send your pull request until all of the boxes are ticked.

- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
- [ ] My pull request addresses exactly one patch/feature.
- [ ] I have created a branch for this patch/feature.
- [ ] Each individual commit in the pull request is meaningful.
- [ ] If my change requires a change to the documentation, I have updated it accordingly.
- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
- [ ] My pull request addresses exactly one patch/feature.
- [ ] I have created a branch for this patch/feature.
- [ ] Each individual commit in the pull request is meaningful.
- [ ] If my change requires a change to the documentation, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!
60 changes: 30 additions & 30 deletions README.md
Expand Up @@ -3,48 +3,48 @@

# Any Cloud Storage (Omeka S Module)
This module allows you to store your Omeka S files on one of the following external cloud platforms rather than the local server disk:
* [Amazon S3 Storage](https://aws.amazon.com/s3/)
* [Microsoft Azure Storage](https://azure.microsoft.com/en-us/services/storage/)
* [Google Cloud Storage](https://cloud.google.com/storage/)
* [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/) (uses the Amazon S3 Storage adapter)
* [Scaleway Object Storage](https://www.scaleway.com/object-storage/) (uses the Amazon S3 Storage adapter)
* [Rackspace Files](https://www.rackspace.com/cloud/files)
* [Dropbox](https://www.dropbox.com)
* [Amazon S3 Storage](https://aws.amazon.com/s3/)
* [Microsoft Azure Storage](https://azure.microsoft.com/en-us/services/storage/)
* [Google Cloud Storage](https://cloud.google.com/storage/)
* [DigitalOcean Spaces](https://www.digitalocean.com/products/spaces/) (uses the Amazon S3 Storage adapter)
* [Scaleway Object Storage](https://www.scaleway.com/object-storage/) (uses the Amazon S3 Storage adapter)
* [Rackspace Files](https://www.rackspace.com/cloud/files)
* [Dropbox](https://www.dropbox.com)

It uses a filesystem abstraction system called [Flysystem](http://flysystem.thephpleague.com/docs/). You can build your own adapters to use with the system if there is a cloud storage system you would like to use but is not currently available via this module.

It is recommended that once you pick an external storage service you continue using it as migrating to a different external file system is not currently supported.

# Installation and Configuration
1. Install the plugin by [downloading and unzipping the latest module](https://github.com/HBLL-Collection-Development/omeka-s-any-cloud/releases) and loading it into the `modules` directory of your Omeka S instance.
2. Enable the plugin from the Admin side of your installation under “Modules”.
3. Configure the module from the Admin side to include credentials for the cloud storage system you would like to use:
## Installation and Configuration
1. Install the plugin by [downloading and unzipping the latest module](https://github.com/HBLL-Collection-Development/omeka-s-any-cloud/releases) and loading it into the `modules` directory of your Omeka S instance.
2. Enable the plugin from the Admin side of your installation under “Modules”.
3. Configure the module from the Admin side to include credentials for the cloud storage system you would like to use:

After that, when you upload media for an item, it will upload to your selected cloud service rather than to your server's local storage.

# Known Issues
1. No migration from one cloud/filesystem to another. Pick one or manually transfer things if you decide to change services.
2. The Rackspace Files adapter currently relies on an outdated version of the Guzzle package which causes problems authenticating to the service. See [this forum posting](https://community.rackspace.com/products/f/dedicated-hybrid-hosting-forum/8674/rackspace-public-cloud-php-opencloud-sdk-errors-due-to-outdated-certificate-authority-list/14415) for the solution which involves downloading an updated security certificate and placing it in the correct directory in the `vendor` directory. There are several issues requesting a fix but I don't know when those will be resolved. Until then, the instructions in that forum work well:
1. Download the updated certificate authority file here: <https://curl.haxx.se/ca/cacert.pem>
2. Replace Guzzle's certificate authority file with the updated one. It is located at: `/path/to/omeka/modules/AnyCloud/vendor/guzzle/guzzle/src/Guzzle/Http/Resources/cacert.pem`
3. There is also an authentication issue with Rackspace Files if you use Multi-Factor Authentication (MFA). MFA must be disabled on your account for this adapter to work. Hopefully both of these issues are addressed soon.
## Known Issues
1. No migration from one cloud/filesystem to another. Pick one or manually transfer things if you decide to change services.
2. The Rackspace Files adapter currently relies on an outdated version of the Guzzle package which causes problems authenticating to the service. See [this forum posting](https://community.rackspace.com/products/f/dedicated-hybrid-hosting-forum/8674/rackspace-public-cloud-php-opencloud-sdk-errors-due-to-outdated-certificate-authority-list/14415) for the solution which involves downloading an updated security certificate and placing it in the correct directory in the `vendor` directory. There are several issues requesting a fix but I don't know when those will be resolved. Until then, the instructions in that forum work well:
1. Download the updated certificate authority file here: <https://curl.haxx.se/ca/cacert.pem>
2. Replace Guzzle's certificate authority file with the updated one. It is located at: `/path/to/omeka/modules/AnyCloud/vendor/guzzle/guzzle/src/Guzzle/Http/Resources/cacert.pem`
3. There is also an authentication issue with Rackspace Files if you use Multi-Factor Authentication (MFA). MFA must be disabled on your account for this adapter to work. Hopefully both of these issues are addressed soon.

# Warning
## Warning
Use this module at your own risk.

It’s always recommended to backup your files and databases and to check your archives regularly so you can roll back if needed.

# Troubleshooting
## Troubleshooting
See online issues on the [module issues](https://github.com/HBLL-Collection-Development/omeka-s-any-cloud/issues) page on GitHub.

# TODO
1. - [X] Remove need for users to manually change the alias in `config/local.config.php` (v0.2.0)
2. - [X] Move all config data to a form so users can use the admin module system to enter their credentials without the need to access server files (v0.2.0)
3. - [X] Make config forms prettier and easier to use (v0.3.0)
3. - [ ] Provide more detailed instructions on setting up each cloud storage system (possibly using the GitHub wiki)

# Possible Enhancements
1. - [ ] Add more cloud adapters (OneDrive, Box.com)
2. - [ ] Allow migration between different cloud platforms
3. - [ ] Support [Archive Repertory](Archive Repertory)
4. - [ ] Support module translation
## TODO
1. - [X] Remove need for users to manually change the alias in `config/local.config.php` (v0.2.0)
2. - [X] Move all config data to a form so users can use the admin module system to enter their credentials without the need to access server files (v0.2.0)
3. - [X] Make config forms prettier and easier to use (v0.3.0)
4. - [ ] Provide more detailed instructions on setting up each cloud storage system (possibly using the GitHub wiki)

## Possible Enhancements
1. - [ ] Add more cloud adapters (OneDrive, Box.com)
2. - [ ] Allow migration between different cloud platforms
3. - [ ] Support [Archive Repertory](Archive Repertory)
4. - [ ] Support module translation

0 comments on commit f2295ea

Please sign in to comment.