Ckeditor5: [Docs] Sample with full features set

Created on 15 Oct 2019  ·  3Comments  ·  Source: ckeditor/ckeditor5

📝 Provide a description of requested docs changes

Currently, with introduced Responsive toolbar it's worth to consider a "full feature" sample.

At this moment discoverability of editor features is really poor. We don't' have any demo/page with listed features of CKEditor 5, even on our website. The new user is only able to scroll the Features menu on documentation page or check Features section in our README.

It would be much easier to include every single feature in one demo and give users a possibility to "play" with them instead of checking a single dedicated sample/page.

Note: It might be a blocker: https://github.com/ckeditor/ckeditor5/issues/5586.

cc @Reinmar @mlewand @oleq @AnnaTomanek

docs discussion docs question

Most helpful comment

I'm having second doubts here. We've been here in the past – with editors that support everything. It kinda works because it seems that the editor can do everything. But somehow, with time, starting from CKEditor 4.0, we moved in the other direction.

Why?

  • There's no single editor with all features. Some will be always missed. Either due to conflicts between implementations, due to various ways they can be configured, due to multiple editor types (which are also seen as "features"), etc. At some point, we may have so many features that people may actually have problems finding them in that demo.
  • We have dozens of pages in our docs. Just one demo of full-featured editor will not be easy to find.
  • Such an editor should not be used in practice. If we'll have it in the docs we should be explaining that "no, no, we can do that, but you shouldn't".
  • But despite that, such an editor will become a "go to" place for many people. It becomes linked, shown, screenshoted, etc. Suddenly, when you google CKEditor you will see mostly this bloated editor. That's how it looked in the past. It took us many years to replace the "full" preset with the "std" preset in peoples' minds and in Google.

But, at the same time, I completely agree that we have discoverability issues. I'd look for alternative options:

  • Having a well-formatted list of all features in https://ckeditor.com/docs/ckeditor5/latest/features/index.html (https://github.com/ckeditor/ckeditor5/issues/5702).
  • Making it clear in all examples, that the showcased editor doesn't contain all features (#1188). We can link to that list from here.
  • And perhaps more.

WDYT?

All 3 comments

Placement

Content

It would be nice to present a demo with a lot of features. We will need help from the marketing team for sure. cc @PiotrMaciej

Screenshot 2019-10-16 at 12 26 52

Toolbar items

What is more important to show at first? Table or font color? Undo/redo or MediaEmbed? It's a question to you guys, do you have any ideas about improving the order of toolbar items?

Screenshot 2019-10-16 at 12 26 00

I'm having second doubts here. We've been here in the past – with editors that support everything. It kinda works because it seems that the editor can do everything. But somehow, with time, starting from CKEditor 4.0, we moved in the other direction.

Why?

  • There's no single editor with all features. Some will be always missed. Either due to conflicts between implementations, due to various ways they can be configured, due to multiple editor types (which are also seen as "features"), etc. At some point, we may have so many features that people may actually have problems finding them in that demo.
  • We have dozens of pages in our docs. Just one demo of full-featured editor will not be easy to find.
  • Such an editor should not be used in practice. If we'll have it in the docs we should be explaining that "no, no, we can do that, but you shouldn't".
  • But despite that, such an editor will become a "go to" place for many people. It becomes linked, shown, screenshoted, etc. Suddenly, when you google CKEditor you will see mostly this bloated editor. That's how it looked in the past. It took us many years to replace the "full" preset with the "std" preset in peoples' minds and in Google.

But, at the same time, I completely agree that we have discoverability issues. I'd look for alternative options:

  • Having a well-formatted list of all features in https://ckeditor.com/docs/ckeditor5/latest/features/index.html (https://github.com/ckeditor/ckeditor5/issues/5702).
  • Making it clear in all examples, that the showcased editor doesn't contain all features (#1188). We can link to that list from here.
  • And perhaps more.

WDYT?

We could have a mega-build with all the most common/usable features. Not necessarily on features' landing page, but referenced there - should do. As this is virtually impossible to put all the features in it, we could try coming up with more than one - like cooperation oriented (comments and track changes), simplicity oriented (autoformatting etc.).

Also: doesn't onlinehtmleditor kinda serve this very purpose? It should be updated with the newest features, sure, but this is a good start.

I'm not sure about

Making it clear in all examples, that the showcased editor doesn't contain all features

Putting a piece of information in each guide about it? The very idea is cool, but I can't really picture the execution. We could easily put it on the main features page once this gets a makeover, but people often bypass it, coming for specific features.

Also: do we have an in-editor help button? Or context help?

Was this page helpful?
0 / 5 - 0 ratings