Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jawngee
jawngee committed Nov 9, 2019
1 parent b487a38 commit 7e21ad7
Show file tree
Hide file tree
Showing 24 changed files with 37 additions and 40 deletions.
4 changes: 2 additions & 2 deletions classes/Tools/ToolsManager.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -540,7 +540,7 @@ public function addMenus( $networkMode, $networkAdminMenu )
'Documentation',
'Documentation',
'manage_options',
'https://help.mediacloud.press/'
'https://kb.mediacloud.press/'
);
foreach ( $this->tools as $key => $tool ) {
$tool->registerHelpMenu( 'media-cloud', $networkMode, $networkAdminMenu );
Expand Down Expand Up @@ -791,7 +791,7 @@ public function renderSettings()
$sections[] = [
'title' => $section['title'],
'id' => $section['id'],
'doc_beacon' => arrayPath( $selectedTool->toolInfo, "settings/groups/{$section['id']}/doc_beacon", null ),
'doc_link' => arrayPath( $selectedTool->toolInfo, "settings/groups/{$section['id']}/doc_link", null ),
'help' => $help,
'description' => arrayPath( $selectedTool->toolInfo, "settings/groups/{$section['id']}/description", null ),
];
Expand Down
1 change: 0 additions & 1 deletion config/crop.config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"groups" => [
"ilab-media-crop-settings" => [
"title" => "Crop Settings",
"doc_beacon" => '51',
"options" => [
"mcloud-crop-quality" => [
"title" => "Crop Quality",
Expand Down
4 changes: 2 additions & 2 deletions config/imgix.config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
"groups" => [
"ilab-media-imgix-settings" => [
"title" => "Imgix Settings",
"doc_beacon" => '88',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/imgix/imgix-settings',
"description" => "Required settings for getting the Imgix integration working.",
"options" => [
"mcloud-imgix-domains" => [
Expand All @@ -73,7 +73,7 @@
],
"ilab-media-imgix-image-settings" => [
"title" => "Imgix Image Settings",
"doc_beacon" => '89',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/imgix/imgix-image-settings',
"options" => [
"mcloud-imgix-default-quality" => [
"title" => "Lossy Image Quality",
Expand Down
16 changes: 8 additions & 8 deletions config/storage.config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,23 +48,23 @@
'config' => '/storage/s3.config.php',
'help' => [
[ 'title' => 'Watch Tutorial', 'url' => 'https://www.youtube.com/watch?v=kjFCACrPRtU' ],
[ 'title' => 'Read Documentation', 'url' => 'https://help.mediacloud.press/article/38-setting-up-amazon-s3', 'beacon_id' => '38' ],
[ 'title' => 'Read Documentation', 'url' => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-amazon-s3' ],
]
],
'google' => [
'name' => 'Google Cloud Storage',
'class' => "\\ILAB\\MediaCloud\\Storage\\Driver\\GoogleCloud\\GoogleStorage",
'config' => '/storage/google.config.php',
'help' => [
[ 'title' => 'Read Documentation', 'url' => 'https://help.mediacloud.press/article/45-setting-up-google-cloud-storage', 'beacon_id' => '45' ],
[ 'title' => 'Read Documentation', 'url' => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-google-cloud-storage' ],
]
],
'do' => [
'name' => 'DigitalOcean Spaces',
'class' => "\\ILAB\\MediaCloud\\Storage\\Driver\\S3\\DigitalOceanStorage",
'config' => '/storage/do.config.php',
'help' => [
[ 'title' => 'Read Documentation', 'url' => 'https://help.mediacloud.press/article/44-setting-up-digital-ocean-spaces', 'beacon_id' => '44' ],
[ 'title' => 'Read Documentation', 'url' => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-digitalocean-spaces' ],
]
],
'minio' => [
Expand All @@ -79,7 +79,7 @@
'class' => "\\ILAB\\MediaCloud\\Storage\\Driver\\S3\\WasabiStorage",
'config' => '/storage/wasabi.config.php',
'help' => [
[ 'title' => 'Read Documentation', 'url' => 'https://help.mediacloud.press/article/46-setting-up-wasabi', 'beacon_id' => '46' ],
[ 'title' => 'Read Documentation', 'url' => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-wasabi' ],
]
],
'other-s3' => [
Expand All @@ -94,7 +94,7 @@
'class' => \ILAB\MediaCloud\Storage\Driver\Backblaze\BackblazeStorage::class,
'config' => '/storage/backblaze.config.php',
'help' => [
[ 'title' => 'Read Documentation', 'url' => 'https://help.mediacloud.press/article/43-setting-up-backblaze', 'beacon_id' => '43' ],
[ 'title' => 'Read Documentation', 'url' => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-backblaze' ],
]
],
],
Expand Down Expand Up @@ -133,7 +133,7 @@
"ilab-media-cloud-upload-handling" => [
"title" => "Upload Handling",
"dynamic" => true,
"doc_beacon" => '39',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/upload-handling-settings',
"description" => "The following options control how the storage tool handles uploads.",
"options" => [
"mcloud-storage-prefix" => [
Expand Down Expand Up @@ -205,7 +205,7 @@
],
"ilab-media-cloud-cdn-settings" => [
"title" => "CDN Settings",
"doc_beacon" => '40',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/cdn-settings',
"description" => "If you are using CloudFront, Fastly or another CDN, enter the CDN domain here. If you are using Imgix, the <b>CDN Base URL</b> setting is ignored, but the <b>Document CDN Base URL</b> is not. If both are left blank, Media Tools will use the cloud storage URLs.",
"options" => [
"mcloud-storage-cdn-base" => [
Expand All @@ -222,7 +222,7 @@
],
"ilab-media-cloud-display-settings" => [
"title" => "Display Settings",
"doc_beacon" => '41',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/media-library-integration',
"description" => "",
"options" => [
"mcloud-storage-display-badge" => [
Expand Down
2 changes: 1 addition & 1 deletion config/storage/s3.config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"ilab-media-cloud-provider-settings" => [
"title" => "Provider Settings",
"dynamic" => true,
"doc_beacon" => '38',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/cloud-storage/setting-up-amazon-s3',
"options" => [
"mcloud-storage-s3-access-key" => [
"title" => "Access Key",
Expand Down
2 changes: 1 addition & 1 deletion config/vision.config.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
],
"ilab-vision-options" => [
"title" => "Vision Options",
"doc_beacon" => '96',
"doc_link" => 'https://kb.mediacloud.press/articles/documentation/vision/vision-options',
"dynamic" => true,
"options" => [
"mcloud-vision-detect-faces" => [
Expand Down
4 changes: 2 additions & 2 deletions ilab-media-tools.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Plugin URI: https://github.com/interfacelab/ilab-media-tools
Description: Automatically upload media to Amazon S3 and integrate with Imgix, a real-time image processing CDN. Boosts site performance and simplifies workflows.
Author: interfacelab
Version: 3.2.5
Version: 3.2.6
Author URI: http://interfacelab.io
*/
// Copyright (c) 2016 Interfacelab LLC. All rights reserved.
Expand Down Expand Up @@ -93,7 +93,7 @@
}

// Version Defines
define( 'MEDIA_CLOUD_VERSION', '3.2.5' );
define( 'MEDIA_CLOUD_VERSION', '3.2.6' );
define( 'MEDIA_CLOUD_INFO_VERSION', '1.0.0' );
// Directory defines
define( 'ILAB_TOOLS_DIR', dirname( __FILE__ ) );
Expand Down
2 changes: 1 addition & 1 deletion public/css/ilab-media-cloud.css
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion public/js/ilab-media-direct-upload.js
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion public/js/ilab-media-grid.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion public/js/mcloud-admin.js
View file

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Requires at least: 4.4
Tested up to: 5.2.4
License: GPLv3 or later
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Stable tag: 3.2.5
Stable tag: 3.2.6
Requires PHP: 5.6.4

Automatically store media on Amazon S3, Google Cloud Storage, DigitalOcean Spaces + others. Serve CSS/JS assets through CDNs. Integrate with Imgix.
Expand Down Expand Up @@ -108,8 +108,9 @@ No, I'm just one very enthusiastic customer.

== Changelog ==

= 3.2.5 =
= 3.2.6 =

* Updated documentation
* Vastly improved NextGen Galleries integration (Premium)
* New Migrate to NextGen Galleries task to import all of your existing NextGen Galleries to cloud storage (Premium)
* Fix for you insane people have that PHP memory limits specified in gigabytes
Expand Down
2 changes: 1 addition & 1 deletion views/base/fields/help.blade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
@foreach($data as $id => $helpLinks)
<div id="doc-links-{{$id}}" class="doc-links-setting" @if(!$loop->first) style="display:none" @endif>
@foreach($helpLinks as $helpLink)
<a href="{{$helpLink['url']}}" target="_blank" class="{{$classes}} {{\ILAB\MediaCloud\Utilities\arrayPath($helpLink, 'class', '')}}" @if(!empty($helpLink['beacon_id'])) data-beacon-article-sidebar="{{$helpLink['beacon_id']}}" @endif>{{$helpLink['title']}}</a>
<a href="{{$helpLink['url']}}" target="_blank" class="{{$classes}} {{\ILAB\MediaCloud\Utilities\arrayPath($helpLink, 'class', '')}}" @if(!empty($helpLink['url'])) data-article-sidebar="{{$helpLink['url']}}" @endif>{{$helpLink['title']}}</a>
@endforeach
</div>
@if(!empty($watch))
Expand Down
4 changes: 2 additions & 2 deletions views/base/settings.blade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@
@if(!empty($section['title']))
<h2>
{{$section['title']}}
@if(!empty($section['doc_beacon']))
<a href="#" class="help-beacon" data-beacon-article-inline="{{$section['doc_beacon']}}">
@if(!empty($section['doc_link']))
<a href="{{$section['doc_link']}}" class="help-beacon" data-article-inline="{{$section['doc_link']}}">
Help
</a>
@endif
Expand Down
2 changes: 1 addition & 1 deletion views/imgix/ilab-imgix-ui.blade.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{{ __('Edit Image') }} ({{$full_width}} x {{$full_height}})
@endif
<div class="modal-actions">
<a href="https://help.mediacloud.press/article/53-image-editor" target="_blank" data-beacon-article-sidebar="53" class="button button-small">@inline('ilab-ui-icon-help.svg') Help</a>
<a href="https://kb.mediacloud.press/articles/documentation/tools/image-editor" target="_blank" data-article-sidebar="https://kb.mediacloud.press/articles/documentation/tools/image-editor" class="button button-small">@inline('ilab-ui-icon-help.svg') Help</a>
<a href="https://www.youtube.com/watch?v=blFUKzOsbXs" class="button button-small mediabox">@inline('ilab-ui-icon-youtube.svg') Tutorial</a>
</div>
@endsection
Expand Down
Loading

0 comments on commit 7e21ad7

Please sign in to comment.