diff --git a/.rename.sh b/.rename.sh deleted file mode 100755 index 535b931..0000000 --- a/.rename.sh +++ /dev/null @@ -1,7 +0,0 @@ -find ./ -type f -print0 | xargs -0 perl -pi -e 's/Disciple_Tools_Media/Disciple_Tools_Media/g'; -find ./ -type f -print0 | xargs -0 perl -pi -e 's/disciple_tools_media/disciple_tools_media/g'; -find ./ -type f -print0 | xargs -0 perl -pi -e 's/disciple-tools-media/disciple-tools-media/g'; -find ./ -type f -print0 | xargs -0 perl -pi -e 's/media/media/g'; -find ./ -type f -print0 | xargs -0 perl -pi -e 's/Media/Media/g'; -mv disciple-tools-plugin-starter-template.php disciple-tools-media.php -# rm .rename.sh diff --git a/README.md b/README.md index 45e1242..cafbefc 100644 --- a/README.md +++ b/README.md @@ -8,35 +8,25 @@ Disciple.Tools - Storage is intended to help manage connections with remote obje Provide the ability to store/retrieve all storage content within 3rd party object storage services; offering greater security. -A detailed description of the typical usage flow for creating and using connections is provided below. +## API -## Usage +See the [API Documentation](https://github.com/DiscipleTools/disciple-tools-storage/wiki/API) for more information. +```php +DT_Storage::get_file_url( string $key = '' ) +``` +```php +DT_Storage::upload_file( string $key_prefix = '', array $upload = [], string $existing_key = '', array $args = [] ) +``` -#### Will Do +## Setup -- Create multiple object storage services connections. -- Test supplied connection credentials. -- Select default connection to be used for file storage within D.T theme. -- Edit user profile pictures. - -#### Will Not Do - -- Add media content to comments. -- Add media content to records. - -#### Typical Usage Flow - -- In order to use the new D.T Storage Plugin, ensure PHP version 8.1 or greater has been installed. - -![0](/documentation/readme/imgs/0.png) - -- Once D.T Storage Plugin has been installed, create a new connection. +- Once D.T Storage Plugin has been installed, create a new connection. Go to WP Admin > Extensions (D.T) > Storage. ![1](/documentation/readme/imgs/1.png) - The following connection types (3rd Party Object Storage Services) are currently supported: - [AWS S3](https://aws.amazon.com/s3/) - - [BackBlaze](https://www.backblaze.com/) + - [BackBlaze](https://www.backblaze.com/) - Set our [BackBlaze setup notes](https://github.com/DiscipleTools/disciple-tools-storage/wiki/S3-Storage-Services#backblaze) - [MinIO](https://min.io/) @@ -46,19 +36,6 @@ A detailed description of the typical usage flow for creating and using connecti > If no endpoint protocol scheme is specified; then https:// will be used. -- Test connection, to ensure supplied credentials are valid. - -![3](/documentation/readme/imgs/3.png) - -- The following will be shown for failed connection tests. - -![4](/documentation/readme/imgs/4.png) - -> Some important things to note when working with Backblaze services: -> -> - Ensure sufficient CORS permissions have been applied to target Backblaze bucket, as shown below: - -![5](/documentation/readme/imgs/5.png) - Once new connection has been validated and saved, navigate to Storage Settings section within D.T General Settings and select connection to be used for the default media storage within D.T. diff --git a/documentation/community/starter-banners/README.md b/documentation/community/starter-banners/README.md deleted file mode 100644 index 80de9e4..0000000 --- a/documentation/community/starter-banners/README.md +++ /dev/null @@ -1,4 +0,0 @@ -# Banners - -These are starter banner templates that can be used when submitting your plugin to the plugin community. If you -choose to not use these templates, just create a graphic with the same dimensions. 1544x500 diff --git a/documentation/community/starter-banners/banner-blue-green.png b/documentation/community/starter-banners/banner-blue-green.png deleted file mode 100644 index b7a55a2..0000000 Binary files a/documentation/community/starter-banners/banner-blue-green.png and /dev/null differ diff --git a/documentation/community/starter-banners/banner-blue-orange.png b/documentation/community/starter-banners/banner-blue-orange.png deleted file mode 100644 index 7181b02..0000000 Binary files a/documentation/community/starter-banners/banner-blue-orange.png and /dev/null differ diff --git a/documentation/community/starter-banners/banner-green-blue.png b/documentation/community/starter-banners/banner-green-blue.png deleted file mode 100644 index 7d4d527..0000000 Binary files a/documentation/community/starter-banners/banner-green-blue.png and /dev/null differ diff --git a/documentation/community/starter-banners/banner-green-orange.png b/documentation/community/starter-banners/banner-green-orange.png deleted file mode 100644 index 3f23903..0000000 Binary files a/documentation/community/starter-banners/banner-green-orange.png and /dev/null differ diff --git a/documentation/community/starter-banners/banner-orange-green.png b/documentation/community/starter-banners/banner-orange-green.png deleted file mode 100644 index 838fff7..0000000 Binary files a/documentation/community/starter-banners/banner-orange-green.png and /dev/null differ diff --git a/documentation/community/starter-banners/banner-orange.png b/documentation/community/starter-banners/banner-orange.png deleted file mode 100644 index aa8abca..0000000 Binary files a/documentation/community/starter-banners/banner-orange.png and /dev/null differ diff --git a/documentation/community/starter-readme.md b/documentation/community/starter-readme.md deleted file mode 100644 index 589fbdc..0000000 --- a/documentation/community/starter-readme.md +++ /dev/null @@ -1,62 +0,0 @@ -![Build Status](https://github.com/DiscipleTools/disciple-tools-storage/actions/workflows/ci.yml/badge.svg?branch=master) - -# Disciple.Tools - Storage - -__Kick start your Disciple.Tools plugin project with this template!__ - -__This plugin is a collection of our best practices and code bases for creating Disciple.Tools plugins.__ - -## Purpose - -A team, organization, or movement effort might love Disciple.Tools, but __wish it had one more thing.__ - -We know that even though we have a common commission to make disciples of all nations, yet our assignments -on how to do that differ greatly or even if we share similar values our stages in movement differ. Either way, -we know we can't create everything everyone needs. - -Instead of waiting for us, you can run ahead on your own. This -plugin includes all our best practices and starter codes for the most commonly developed extensions. - -We have included starter code for a new post-type, a new REST API endpoint, a new admin page, or a new metrics chart. -The template also provides code quality and code style tools, Github Actions integration, multi-language support, activation and -deactivation functions, and more. In truth it's likely more than your project needs, so we'll -guide you through removing the elements your project does not need.) - -__This plugin is for developers__ who want to extend the Disciple.Tools system for their movement effort. - -## Included -#### Framework - - 1. Wordpress code style requirements. ```phpcs.xml``` - 1. PHP Code Sniffer support (composer) @use ```/vendor/bin/phpcs``` and ```/vendor/bin/phpcbf``` - 1. Github Actions Continuous Integration ```.githbub/workflows/ci.yml``` - 1. Disciple.Tools Theme presence check. ```disciple_tools_storage()``` - 1. Remote upgrade system for ongoing updates outside the Wordpress Directory. - 1. Multilingual support. ```/languages``` & ```default.pot``` - -#### Components - - 1. Sample admin menu and admin page with starter tabs component. - 1. Sample post-type class and hooks. - 1. Sample metrics chart, javascript, and REST api. - 1. Sample REST api. - 1. Sample site-to-site link hooks. - 1. Sample custom tile code. - -## Recommended - -- [Composer](https://getcomposer.org/download/). -- Disciple.Tools Theme installed on a local Wordpress Server ([localwp.com](https://localwp.com) or [MAMP](https://www.mamp.info)). - -## Contribution - -Contributions welcome. You can report issues and bugs in the -[Issues](https://github.com/DiscipleTools/disciple-tools-storage/issues) section of the repo. You can present ideas -in the [Discussions](https://github.com/DiscipleTools/disciple-tools-storage/discussions) section of the repo. And -code contributions are welcome using the [Pull Request](https://github.com/DiscipleTools/disciple-tools-storage/pulls) -system for git. For a more details on contribution see the -[contribution guidelines](https://github.com/DiscipleTools/disciple-tools-storage/blob/master/CONTRIBUTING.md). - -## Screenshots - -![screenshot](https://via.placeholder.com/600x150)