浏览代码

Merge branch t/upload-docs

Docs: New image upload docs.
Piotrek Koszuliński 7 年之前
父节点
当前提交
1908a76fcd

+ 4 - 2
packages/ckeditor5-adapter-ckfinder/README.md

@@ -10,11 +10,13 @@ CKFinder adapter for CKEditor 5
 [![Dependency Status](https://david-dm.org/ckeditor/ckeditor5-adapter-ckfinder/status.svg)](https://david-dm.org/ckeditor/ckeditor5-adapter-ckfinder)
 [![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-adapter-ckfinder/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-adapter-ckfinder?type=dev)
 
-This package implements an upload adapter to [CKFinder](https://ckeditor.com/ckfinder/)'s backend for CKEditor 5.
+This package implements a CKEditor 5 upload adapter compatible with the [CKFinder file manager and uploader](https://ckeditor.com/ckfinder/)'s server–side connector.
 
 ## Documentation
 
-See the [`@ckeditor/ckeditor5-adapter-ckfinder` package](https://ckeditor.com/docs/ckeditor5/latest/api/adapter-ckfinder.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+See the ["CKFinder integration" guide](https://ckeditor.com/docs/ckeditor5/latest/features/ckfinder.html) and the [plugin documentation](https://ckeditor.com/docs/ckeditor5/latest/api/adapter-ckfinder.html) to learn how to configure the adapter.
+
+Check out the {@link features/image-upload comprehensive "Image upload" guide} to learn about other ways to upload images into CKEditor 5.
 
 ## License
 

+ 4 - 2
packages/ckeditor5-adapter-ckfinder/docs/api/adapter-ckfinder.md

@@ -6,11 +6,13 @@ category: api-reference
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-adapter-ckfinder.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-adapter-ckfinder)
 
-This package implements an upload adapter to [CKFinder](https://ckeditor.com/ckfinder/)'s backend for CKEditor 5.
+This package implements a CKEditor 5 upload adapter compatible with the [CKFinder file manager and uploader](https://ckeditor.com/ckfinder/)'s server–side connector.
 
 ## Documentation
 
-See the {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter} plugin documentation and the {@link features/image#image-upload Image upload} section in the {@link features/image Image feature} guide.
+See the {@link features/ckfinder "CKFinder integration" guide} and the {@link module:adapter-ckfinder/uploadadapter~CKFinderUploadAdapter plugin documentation} to learn how to configure the adapter.
+
+Check out the {@link features/image-upload comprehensive "Image upload" guide} to learn about other ways to upload images into CKEditor 5.
 
 ## Installation
 

+ 6 - 5
packages/ckeditor5-adapter-ckfinder/src/uploadadapter.js

@@ -14,13 +14,14 @@ import FileRepository from '@ckeditor/ckeditor5-upload/src/filerepository';
 import { getCsrfToken } from './utils';
 
 /**
- * A plugin that enables CKFinder uploads in CKEditor 5.
+ * A plugin that enables file uploads in CKEditor 5 using the CKFinder server–side connector.
  *
- * You can configure it by using
- * {@link module:ckfinder/ckfinder~CKFinderConfig#uploadUrl `ckfinder.uploadUrl`}.
+ * See the {@glink features/ckfinder "CKFinder integration" guide} to learn how to configure
+ * and use this feature as well as find out more about the full integration with the file manager
+ * provided by the {@link module:ckfinder/ckfinder~CKFinder} plugin.
  *
- * Check out the {@link module:ckfinder/ckfinder~CKFinder CKFinder feature} to learn more about
- * the full integration with the file manager.
+ * Check out the {@glink features/image-upload comprehensive "Image upload" guide} to learn about
+ * other ways to upload images into CKEditor 5.
  *
  * @extends module:core/plugin~Plugin
  */