ckeditor / ckeditor4-sdk

A set of software development tools for CKEditor 4 along with samples.
Other
18 stars 21 forks source link

Restructure SDK navigation, introduce a new "Inserting Images" section #236

Closed wwalc closed 6 years ago

wwalc commented 6 years ago

We are about to introduce the Easy Image sample. Unfortunately it's hard to find a convenient location for it as we have already a "Captioned Images" sample which showcases Image2 (Enhanced Image).

screen shot 2018-02-09 at 12 20 16

Inserting Images

When thinking about the Easy Image sample, I realised that the CKEditor 4 offer regarding images will be completely confusing for someone who's new to the editor. It's quite uncommon to have three different solutions for the same problem.

Since we are talking about three different solutions for users to discover, we need to demo the correctly. We cannot do this by offering samples just for two of them. We need to have a sample with each plugin, so that the user could clearly understand what each feature offers.

Three samples are enough to make a separate group out of it:

screen shot 2018-02-09 at 12 19 53

Dedicated Image samples

Explain using as little text as possible the key features of a plugin. Make sure to list all the functionality that makes the plugin unique and suitable for particular use cases (e.g. include in the description of the Image plugin that it offers setting border / vspace / hspace for pixel-perfect positioning of images).

In each sample explain what are the possibilities when it comes to uploading images:

Where to put this info? In each sample make a second section called "Uploading Images", where there'd be just text. The demo in the first section could already contain all the relevant code to support uploading images. This way we'd avoid having confusing sample, where the first demo would not support uploading and a fully working feature would be available just in the second demo.

Also by having a second section "Uploading Images" below the editor we can save some space on top, so that the working editor sample was not preceded by a wall of text.

What with the File Upload sample?

It should stay where he is. However the "Uploading Images" section should serve now just as a reference link to dedicated Image samples where uploading is explained.

screen shot 2018-02-09 at 12 25 01

About Easy Image

We can show the differences between three Image plugins also by showing them in a different context.

wwalc commented 6 years ago

As a side effect, the navigation and structure of documentation will have to be changed as well to reflect the SDK user journey: https://docs.ckeditor.com/ckeditor4/latest/guide/dev_captionedimage.html