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

Create a list of all end-user features #5702

Closed
Reinmar opened this issue Nov 4, 2019 · 8 comments
Closed

Create a list of all end-user features #5702

Reinmar opened this issue Nov 4, 2019 · 8 comments
Labels
resolution:resolved This issue was already resolved (e.g. by another ticket). squad:ccx Issue to be handled by the CCX team. status:discussion type:docs This issue reports a task related to documentation (e.g. an idea for a guide).

Comments

@Reinmar
Copy link
Member

Reinmar commented Nov 4, 2019

Currently, it's a bit hard to quickly skim through all features that we support. There's only the sidebar on https://ckeditor.com/docs/ckeditor5/latest/features/index.html, but it doesn't list all of the options, just categories. Plus, some of those categories are a bit bloated like the collaboration section or image upload.

I'd like to see a better compilation of available end-user features in the content of https://ckeditor.com/docs/ckeditor5/latest/features/index.html.

This list can, besides just listing the names of the features, also list all available plugins. This is actually an idea which I heard from our community – that we don't list somewhere all the available plugins.

@Reinmar Reinmar added type:docs This issue reports a task related to documentation (e.g. an idea for a guide). status:discussion labels Nov 4, 2019
@Reinmar Reinmar added this to the next milestone Nov 4, 2019
@Reinmar Reinmar modified the milestones: next, nice-to-have Nov 4, 2019
@AnnaTomanek AnnaTomanek added the squad:ccx Issue to be handled by the CCX team. label Oct 19, 2020
@godai78
Copy link
Contributor

godai78 commented Oct 27, 2020

This will be (at least partially) covered by this issue https://github.com/cksource/content-documentation-proofread/issues/332 aiming at discoverability. In the end the features overview/landing page will be rewritten to accommodate more "tag cloud" to features relations. This is also achieved through the "Related features" block gradually added to all the guides.

As for the plugins list - wouldn't npm list be a good base?

@godai78
Copy link
Contributor

godai78 commented Jun 30, 2021

As for the plugin list, the https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/features-html-output-overview.html kinda covers that scope.

@magda-chrzescian
Copy link
Contributor

As for the plugin list, the https://ckeditor.com/docs/ckeditor5/latest/builds/guides/integration/features-html-output-overview.html kinda covers that scope.

I'm not sure if it actually covers the scope - it is not really more readable than the table of contents on the left. I feel like we are still missing some kind of table, where all of the features and plugins would be displayed in a more structured way so that you can scan them with your eyes easily.

I would see it as a table with information about each feature, which plugins does it incorporate, in which builds are they enabled by default. There also might be a link to the API docs, configurations, HTML output page, we could show relations between plugins... and many more, I'm not sure how far we can go keeping the table readable - it needs some design.

Also, though we have the plugins list on the HTML output page, I'm not sure if I would think of opening it looking for that list. Also, it is not very clear visually. Moreover, searching for the "plugins list" gets us here:
image
As a follow-up, we need to identify the list of the "most wanted" keywords in our documentation and make sure that they are possible to find easily.


We might also think about how the documentation features page refers to the marketing features page (which is actually the second result in the google search for "ckeditor5 features", after our documentation).

  • What do we want to say in the documentation other than on the marketing page?
  • Do we want to duplicate information?
  • Do we want to link these pages? How?

@godai78
Copy link
Contributor

godai78 commented Jul 14, 2021

I meant more to say, that we have the list, not that this very page can serve the purpose.

Also, how do we group it anyway? Alphabetical is both easiest and most useless. By similarity? Some will overlap several groups. Do we make a tag cloud? 🗡️

@magda-chrzescian
Copy link
Contributor

I'm very curious to see it as a tag cloud, however not sure how it would serve the purpose, again. If we don't want to show any other information than the name to the user, it's fine, but only then.

@pomek pomek removed this from the nice-to-have milestone Feb 21, 2022
@godai78
Copy link
Contributor

godai78 commented Jul 28, 2022

There is also a full list of features (and subfeatures) currently in development by the website/marketing team, aided by CCX. I believe this would conclude the task.

@godai78
Copy link
Contributor

godai78 commented Aug 19, 2022

Here we go: https://ckeditor.com/ckeditor-5/features/

@godai78 godai78 closed this as completed Sep 8, 2023
@godai78 godai78 added the resolution:resolved This issue was already resolved (e.g. by another ticket). label Sep 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
resolution:resolved This issue was already resolved (e.g. by another ticket). squad:ccx Issue to be handled by the CCX team. status:discussion type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

No branches or pull requests

5 participants