Skip to content
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

Add plugin documentation #389

Open
wants to merge 99 commits into
base: uat
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
ddc4d0f
Add hookdoc dependency
pereirinha Mar 19, 2021
464d9df
Update package-lock
pereirinha Mar 19, 2021
8e2ed87
Add hookdoc template
pereirinha Mar 19, 2021
7482211
Add hookdoc configuration
pereirinha Mar 19, 2021
68aa9fc
Update hooks documentation to be properly parsed by hookdoc
pereirinha Mar 19, 2021
c747076
Add compiled docs
pereirinha Mar 19, 2021
75a5855
Ignore linting docs folder
pereirinha Mar 19, 2021
aa6980c
Update documentation build
pereirinha Mar 19, 2021
bfe4ef7
Make the build:docs as part of the build NPM task
pereirinha Mar 19, 2021
ab15665
Merge branch 'uat' into feature/documentation
pereirinha May 18, 2021
011ea96
Merge branch 'master' into feature/documentation
pereirinha Jul 28, 2021
a0eb881
Update documentation 2.7.5
pereirinha Jul 28, 2021
e504058
Fix typo
pereirinha Jul 28, 2021
dbba6a7
Update documentation 2.7.5
pereirinha Jul 28, 2021
4c603d1
Fix typo
pereirinha Jul 28, 2021
322b829
Update documentation 2.7.5
pereirinha Jul 28, 2021
0d6e612
Merge branch 'master' into feature/documentation
pereirinha Sep 21, 2021
40e2145
Update documentation
pereirinha Sep 21, 2021
8f603bd
Merge branch 'master' into feature/documentation
pereirinha Oct 12, 2021
15c142d
Update docs
pereirinha Oct 12, 2021
8d63f41
Bump plugin version
pereirinha Oct 12, 2021
558bbbe
Reorder scripts
pereirinha Dec 3, 2021
2256dc1
Do not add extra line for yml files
pereirinha Dec 3, 2021
26a530d
Add GH workflow to build docs
pereirinha Dec 3, 2021
205e8e1
Merge branch 'fix/delivery-missing-sizes' into feature/documentation
pereirinha Dec 3, 2021
29ad57d
Cleanup
pereirinha Dec 3, 2021
758e098
Update documentation
pereirinha Dec 3, 2021
0d738c3
Update documentation
pereirinha Dec 6, 2021
c176726
Merge branch 'master' into feature/documentation
pereirinha Jan 18, 2022
a1380a9
Update documentation
pereirinha Jan 18, 2022
99a482a
Merge branch 'master' into feature/documentation
pereirinha Apr 26, 2022
7f71f28
Update docs
pereirinha Apr 26, 2022
523e898
Merge branch 'master' into feature/documentation
pereirinha May 31, 2022
e0737ed
Update docs
pereirinha May 31, 2022
55b3456
Merge branch 'master' into feature/documentation
pereirinha Jun 30, 2022
62b5de3
Update documentation
pereirinha Jun 30, 2022
2b74b53
Merge branch 'master' into feature/documentation
pereirinha Jul 27, 2022
85df6dc
Update documentation
pereirinha Jul 27, 2022
4d25434
Merge branch 'master' into feature/documentation
pereirinha Aug 17, 2022
1c46a44
Update documentation
pereirinha Aug 17, 2022
742e6f0
Merge branch 'master' into feature/documentation
pereirinha Sep 13, 2022
e200d76
Update documentation
pereirinha Sep 13, 2022
3c3f5a2
Merge branch 'master' into feature/documentation
pereirinha Oct 26, 2022
c24c640
Update documentation
pereirinha Oct 26, 2022
9216218
Merge branch 'master' into feature/documentation
pereirinha Feb 28, 2023
3e3880c
Update documentation
pereirinha Feb 28, 2023
b74b111
Merge branch 'master' into feature/documentation
pereirinha Mar 30, 2023
c19aaca
Merge branch 'master' into feature/documentation
pereirinha Jun 19, 2023
9d2fb52
Update documentation
pereirinha Jun 19, 2023
8d86f3f
Merge branch 'master' into feature/documentation
pereirinha Aug 23, 2023
3fb11db
Update documentation
pereirinha Aug 23, 2023
30e1674
Merge branch 'master' into feature/documentation
pereirinha Oct 11, 2023
d77bade
Update documentation
pereirinha Oct 11, 2023
a5a5333
Merge branch 'master' into feature/documentation
pereirinha Jan 18, 2024
865fe3c
Update docs
pereirinha Jan 18, 2024
5f2522c
Merge branch 'master' into feature/documentation
pereirinha Feb 22, 2024
803c693
Update documentation
pereirinha Feb 22, 2024
c09d1d2
Bump ip from 1.1.8 to 1.1.9
dependabot[bot] Feb 22, 2024
8e1bdfe
Add Cloudinary Academy info box
pereirinha Mar 4, 2024
af82dfd
Simplify if condition
pereirinha Mar 4, 2024
89174ff
Update readme file
pereirinha Mar 4, 2024
2faec73
Add Cloudinary Academy help box
pereirinha Mar 4, 2024
53eb03b
Update wording
pereirinha Mar 5, 2024
9d231bf
Add academy icons
pereirinha Mar 5, 2024
184481d
Add FAQ entry
pereirinha Mar 6, 2024
390bc94
Confirm that the key exist
pereirinha Mar 5, 2024
c3b073d
Replace the `tmpfile` with `wp_tempnam`
pereirinha Mar 5, 2024
50b28e7
PHPCS fixes
pereirinha Mar 5, 2024
dcd3bd6
Upgrade dependencies
pereirinha Feb 22, 2024
cd4d431
Update docs
pereirinha Mar 25, 2024
4995018
Update lock file
pereirinha Mar 25, 2024
eb3ee8a
Improve styling for color palette
pereirinha Feb 22, 2024
9fb35fa
Update built files
pereirinha Feb 22, 2024
eeb4da3
Bump plugin version
pereirinha Mar 6, 2024
d8b5303
Update template file
pereirinha Mar 6, 2024
a507cc7
Update academy icon
pereirinha Mar 11, 2024
7a43df1
Spread args
pereirinha Mar 11, 2024
8ec7bca
Do not require connection to show the academy help info
pereirinha Mar 11, 2024
08361a6
Bump plugin version
pereirinha Mar 12, 2024
be10a85
Update translations template
pereirinha Mar 12, 2024
374fabf
Add a filter to allow uploading the scaled image instead
pereirinha Mar 12, 2024
d8a745f
Prevent using customer CNAME account on demo page
pereirinha Mar 12, 2024
37665d2
Use American English
pereirinha Mar 12, 2024
98691f0
PHPCS fixes
pereirinha Mar 12, 2024
49b07e1
Bump plugin version
pereirinha Mar 13, 2024
91a85b7
Update translations template
pereirinha Mar 13, 2024
5277216
As `Cloudinary plugin` for consistency
pereirinha Mar 18, 2024
f4d2c04
Bump plugin version
pereirinha Mar 18, 2024
0b10c59
Update translations template
pereirinha Mar 18, 2024
d5830a4
Bump plugin version
pereirinha Mar 25, 2024
ecdf6b1
Bump video player version
pereirinha Mar 25, 2024
4fff999
version bump
bruckercloud Mar 25, 2024
8dac6bc
Update docs
pereirinha Mar 25, 2024
9275203
Merge branch 'master' into feature/documentation
pereirinha Aug 21, 2024
dac6400
Update docs
pereirinha Aug 21, 2024
dd72017
Update documentation
pereirinha Sep 3, 2024
45a5b12
Merge pull request #983 from cloudinary/uat
bruckercloud Sep 18, 2024
2575049
Merge branch 'master' into feature/documentation
pereirinha Sep 20, 2024
cb77118
Update documentation
pereirinha Sep 20, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ indent_size = 2
[*.md]
trim_trailing_whitespace = false

[{.version,.editorconfig}]
[{.version,.editorconfig,*.yml}]
insert_final_newline = false
3 changes: 2 additions & 1 deletion .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
**/vendor/**
**/js/*.js
build/*
built/*
built/*
docs/*
23 changes: 23 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Build Cloudinary Docs

on:
push:
branches:
- master

jobs:
hookdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup node
uses: actions/setup-node@v2
with:
node-version: '12.x'
- run: npm install
- run: npm run build:docs
- name: Deploy to GH Pages
uses: maxheld83/[email protected]
env:
BUILD_DIR: 'docs/'
GH_PAT: ${{ secrets.GH_PAT }}
46 changes: 46 additions & 0 deletions .hookdoc/layout.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title><?js= title ?> - Cloudinary Docs</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">

<link
href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:300,400|Playfair+Display:900&display=swap"
rel="stylesheet">
</head>

<body>

<div id="main">

<?js if (title !== 'Home') { ?>
<h1 class="page-title"><?js= title ?></h1>
<?js } ?>

<?js= content ?>
</div>

<nav>
<?js= this.nav ?>
</nav>

<br class="clear">

<footer>
<a href="https://cloudinary.com/" target="_blank" rel="noopener noreferrer">Cloudinary</a> |
<a href="https://github.com/cloudinary/cloudinary_wordpress/" target="_blank" rel="noopener noreferrer">Cloudinary
on GitHub</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
217 changes: 217 additions & 0 deletions docs/cloudinary_admin_image_settings.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Filter: cloudinary_admin_image_settings - Cloudinary Docs</title>

<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">

<link
href="https://fonts.googleapis.com/css?family=IBM+Plex+Mono|IBM+Plex+Sans:300,400|Playfair+Display:900&display=swap"
rel="stylesheet">
</head>

<body>

<div id="main">


<h1 class="page-title">Filter: cloudinary_admin_image_settings</h1>







<section>

<header>
<h2></h2>

</header>

<article>
<div class="container-overview">





<h4 class="name" id="cloudinary_admin_image_settings">apply_filters( 'cloudinary_admin_image_settings', <span class="signature">$settings )</span><span class="type-signature"> &rarr; {array}</span></h4>





<div class="description">
Filter the Cloudinary global transformations tab for images.
</div>







<h5>Parameters:</h5>


<table class="params">
<thead>
<tr>

<th>Name</th>


<th>Type</th>





<th class="last">Description</th>
</tr>
</thead>

<tbody>


<tr>

<td class="name"><code>$settings</code></td>


<td class="type">


<span class="param-type">array</span>



</td>





<td class="description last">The global transformations settings.</td>
</tr>


</tbody>
</table>






<dl class="details">


























<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="ui-definitions_settings-image.php.html">ui-definitions/settings-image.php</a>, <a href="ui-definitions_settings-image.php.html#line260">line 260</a>
</li></ul></dd>







</dl>













<h5>Returns:</h5>




<dl>
<dt>
Type
</dt>
<dd>

<span class="param-type">array</span>


</dd>
</dl>






</div>


</article>

</section>




</div>

<nav>
<h2><a href="index.html">Home</a></h2><h3>Actions</h3><ul><li><a href="cloudinary_connected.html">cloudinary_connected</a></li><li><a href="cloudinary_delete_asset.html">cloudinary_delete_asset</a></li><li><a href="cloudinary_download_asset.html">cloudinary_download_asset</a></li><li><a href="cloudinary_enable_crop_and_gravity_control.html">cloudinary_enable_crop_and_gravity_control</a></li><li><a href="cloudinary_flush_cache.html">cloudinary_flush_cache</a></li><li><a href="cloudinary_id.html">cloudinary_id</a></li><li><a href="cloudinary_init_delivery.html">cloudinary_init_delivery</a></li><li><a href="cloudinary_init_settings.html">cloudinary_init_settings</a></li><li><a href="cloudinary_is_%257B$class_name%257D_active.html">cloudinary_is_{$class_name}_active</a></li><li><a href="cloudinary_lazy_load_bypass.html">cloudinary_lazy_load_bypass</a></li><li><a href="cloudinary_queue_action.html">cloudinary_queue_action</a></li><li><a href="cloudinary_ready.html">cloudinary_ready</a></li><li><a href="cloudinary_register_sync_types.html">cloudinary_register_sync_types</a></li><li><a href="cloudinary_registered_sizes.html">cloudinary_registered_sizes</a></li><li><a href="cloudinary_responsive_images_bypass_formats.html">cloudinary_responsive_images_bypass_formats</a></li><li><a href="cloudinary_string_replace.html">cloudinary_string_replace</a></li><li><a href="cloudinary_unsync_asset.html">cloudinary_unsync_asset</a></li><li><a href="cloudinary_upgrade_asset.html">cloudinary_upgrade_asset</a></li><li><a href="cloudinary_upload_args.html">cloudinary_upload_args</a></li><li><a href="cloudinary_uploaded_asset.html">cloudinary_uploaded_asset</a></li><li><a href="cloudinary_version_upgrade.html">cloudinary_version_upgrade</a></li></ul><h3>Filters</h3><ul><li><a href="cloudinary_admin_image_settings.html">cloudinary_admin_image_settings</a></li><li><a href="cloudinary_admin_pages.html">cloudinary_admin_pages</a></li><li><a href="cloudinary_admin_video_settings.html">cloudinary_admin_video_settings</a></li><li><a href="cloudinary_allowed_extensions.html">cloudinary_allowed_extensions</a></li><li><a href="cloudinary_api_rest_endpoints.html">cloudinary_api_rest_endpoints</a></li><li><a href="cloudinary_apply_breakpoints.html">cloudinary_apply_breakpoints</a></li><li><a href="cloudinary_apply_default_transformations.html">cloudinary_apply_default_transformations</a></li><li><a href="cloudinary_asset_payload.html">cloudinary_asset_payload</a></li><li><a href="cloudinary_asset_state.html">cloudinary_asset_state</a></li><li><a href="cloudinary_autosync_threads.html">cloudinary_autosync_threads</a></li><li><a href="cloudinary_build_queue_query.html">cloudinary_build_queue_query</a></li><li><a href="cloudinary_bypass_cache.html">cloudinary_bypass_cache</a></li><li><a href="cloudinary_bypass_seo_url.html">cloudinary_bypass_seo_url</a></li><li><a href="cloudinary_can_sync_asset.html">cloudinary_can_sync_asset</a></li><li><a href="cloudinary_content_url.html">cloudinary_content_url</a></li><li><a href="cloudinary_context_options.html">cloudinary_context_options</a></li><li><a href="cloudinary_contextualized_post_id.html">cloudinary_contextualized_post_id</a></li><li><a href="cloudinary_convert_media_types.html">cloudinary_convert_media_types</a></li><li><a href="cloudinary_converted_url.html">cloudinary_converted_url</a></li><li><a href="cloudinary_cron_frequency.html">cloudinary_cron_frequency</a></li><li><a href="cloudinary_cron_start_offset.html">cloudinary_cron_start_offset</a></li><li><a href="cloudinary_current_post_id.html">cloudinary_current_post_id</a></li><li><a href="cloudinary_default_freeform_transformations_%257B$type%257D.html">cloudinary_default_freeform_transformations_{$type}</a></li><li><a href="cloudinary_default_qf_transformations_%257B$type%257D.html">cloudinary_default_qf_transformations_{$type}</a></li><li><a href="cloudinary_default_transformations.html">cloudinary_default_transformations</a></li><li><a href="cloudinary_delivery_get_id.html">cloudinary_delivery_get_id</a></li><li><a href="cloudinary_delivery_searchable_url.html">cloudinary_delivery_searchable_url</a></li><li><a href="cloudinary_doing_upload.html">cloudinary_doing_upload</a></li><li><a href="cloudinary_edit_asset_permalink.html">cloudinary_edit_asset_permalink</a></li><li><a href="cloudinary_filter_out_local.html">cloudinary_filter_out_local</a></li><li><a href="cloudinary_gallery_config.html">cloudinary_gallery_config</a></li><li><a href="cloudinary_gallery_html_container.html">cloudinary_gallery_html_container</a></li><li><a href="cloudinary_get_signature.html">cloudinary_get_signature</a></li><li><a href="cloudinary_home_url.html">cloudinary_home_url</a></li><li><a href="cloudinary_ignored_class_keywords.html">cloudinary_ignored_class_keywords</a></li><li><a href="cloudinary_ignored_data_keywords.html">cloudinary_ignored_data_keywords</a></li><li><a href="cloudinary_is_content_dir.html">cloudinary_is_content_dir</a></li><li><a href="cloudinary_is_deliverable.html">cloudinary_is_deliverable</a></li><li><a href="cloudinary_is_folder_synced.html">cloudinary_is_folder_synced</a></li><li><a href="cloudinary_is_media.html">cloudinary_is_media</a></li><li><a href="cloudinary_is_uploadable_media.html">cloudinary_is_uploadable_media</a></li><li><a href="cloudinary_lazy_load_bypass_classes.html">cloudinary_lazy_load_bypass_classes</a></li><li><a href="cloudinary_lazy_load_bypass_formats.html">cloudinary_lazy_load_bypass_formats</a></li><li><a href="cloudinary_local_url.html">cloudinary_local_url</a></li><li><a href="cloudinary_max_files_import.html">cloudinary_max_files_import</a></li><li><a href="cloudinary_media_context.html">cloudinary_media_context</a></li><li><a href="cloudinary_media_context_query.html">cloudinary_media_context_query</a></li><li><a href="cloudinary_media_context_things.html">cloudinary_media_context_things</a></li><li><a href="cloudinary_media_filters.html">cloudinary_media_filters</a></li><li><a href="cloudinary_media_status.html">cloudinary_media_status</a></li><li><a href="cloudinary_media_types.html">cloudinary_media_types</a></li><li><a href="cloudinary_meta_boxes.html">cloudinary_meta_boxes</a></li><li><a href="cloudinary_migrate_legacy_meta.html">cloudinary_migrate_legacy_meta</a></li><li><a href="cloudinary_on_demand_sync_limit.html">cloudinary_on_demand_sync_limit</a></li><li><a href="cloudinary_parse_element.html">cloudinary_parse_element</a></li><li><a href="cloudinary_plugin_asset_cache_filters.html">cloudinary_plugin_asset_cache_filters</a></li><li><a href="cloudinary_plugin_asset_cache_inline_types.html">cloudinary_plugin_asset_cache_inline_types</a></li><li><a href="cloudinary_prepare_size.html">cloudinary_prepare_size</a></li><li><a href="cloudinary_preview_types.html">cloudinary_preview_types</a></li><li><a href="cloudinary_queue_threads.html">cloudinary_queue_threads</a></li><li><a href="cloudinary_raw_url.html">cloudinary_raw_url</a></li><li><a href="cloudinary_register_extensions.html">cloudinary_register_extensions</a></li><li><a href="cloudinary_resource_type.html">cloudinary_resource_type</a></li><li><a href="cloudinary_seo_public_id.html">cloudinary_seo_public_id</a></li><li><a href="cloudinary_set_usable_asset.html">cloudinary_set_usable_asset</a></li><li><a href="cloudinary_setting_get_value.html">cloudinary_setting_get_value</a></li><li><a href="cloudinary_settings_save_setting.html">cloudinary_settings_save_setting</a></li><li><a href="cloudinary_setup_component_parts.html">cloudinary_setup_component_parts</a></li><li><a href="cloudinary_sync_base.html">cloudinary_sync_base</a></li><li><a href="cloudinary_sync_base_struct.html">cloudinary_sync_base_struct</a></li><li><a href="cloudinary_syncable_delivery_types.html">cloudinary_syncable_delivery_types</a></li><li><a href="cloudinary_task_capability.html">cloudinary_task_capability</a></li><li><a href="cloudinary_task_capability_%257Btask%257D.html">cloudinary_task_capability_{task}</a></li><li><a href="cloudinary_thread_queue_details_query.html">cloudinary_thread_queue_details_query</a></li><li><a href="cloudinary_transformations.html">cloudinary_transformations</a></li><li><a href="cloudinary_upgrade_sequence.html">cloudinary_upgrade_sequence</a></li><li><a href="cloudinary_upload_eager_formats.html">cloudinary_upload_eager_formats</a></li><li><a href="cloudinary_upload_options.html">cloudinary_upload_options</a></li><li><a href="cloudinary_use_original_image.html">cloudinary_use_original_image</a></li><li><a href="cloudinary_validate_cloudinary_id.html">cloudinary_validate_cloudinary_id</a></li></ul>
</nav>

<br class="clear">

<footer>
<a href="https://cloudinary.com/" target="_blank" rel="noopener noreferrer">Cloudinary</a> |
<a href="https://github.com/cloudinary/cloudinary_wordpress/" target="_blank" rel="noopener noreferrer">Cloudinary
on GitHub</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>
Loading