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

Improve feature discoverability in the documentation #5703

Closed
6 of 7 tasks
Reinmar opened this issue Nov 4, 2019 · 7 comments
Closed
6 of 7 tasks

Improve feature discoverability in the documentation #5703

Reinmar opened this issue Nov 4, 2019 · 7 comments
Assignees
Labels
Epic resolution:resolved This issue was already resolved (e.g. by another ticket). squad:ccx Issue to be handled by the CCX team. 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

This epic is about improving the Features guides to make them:

  • Present the features better and in more real-life scenarios.
  • Give more context about what the feature can give you, where and how it can be used.
  • Cross-linked to other similar/related features.
  • Cover the needs of both non-technical people who research what they can achieve with CKEditor 5 and more advanced technical users who need to know how to install, configure and customize the features.
  • Have a common structure that is logical, familiar and easy to browse.

Proposed feature guide structure

  1. Intro section, with some background, context, basic feature explanation.
    1. If the feature is commercial, it a beta, experimental, it should be mentioned here, too.
  2. Related features - referencing similar features or features that can be used in the same context.
  3. Demo - that should cover the most full-blown or the most commonly used version of the feature (image guide!).
  4. Detailed feature information.
  5. Configuration.
  6. Installation.
  7. Common API.
  8. Contribute.

TODO

This is a huge task and it will not be covered in one iteration. Some sub-tasks that could be a part of this epic:

@Reinmar Reinmar added type:docs This issue reports a task related to documentation (e.g. an idea for a guide). status:confirmed labels Nov 4, 2019
@Reinmar Reinmar added this to the next milestone Nov 4, 2019
@Reinmar
Copy link
Member Author

Reinmar commented Dec 20, 2019

cc @panr

@AnnaTomanek AnnaTomanek added the squad:ccx Issue to be handled by the CCX team. label Oct 19, 2020
@godai78 godai78 self-assigned this Oct 28, 2020
@AnnaTomanek AnnaTomanek modified the milestones: next, iteration 38, nice-to-have Oct 28, 2020
@AnnaTomanek AnnaTomanek changed the title [Umbrella] Improve feature discoverability Improve feature discoverability in the documentation Oct 28, 2020
@ckeditor ckeditor deleted a comment from godai78 Oct 28, 2020
@godai78
Copy link
Contributor

godai78 commented Oct 30, 2020

This is planned next (already started to be introduced): #7924 so this will also nicely cover this: #5721

@godai78
Copy link
Contributor

godai78 commented Oct 30, 2020

Stuff done:
* new demos for paste from word and paste from gdocs: #8349 
* adding Markdown output to "related" (step 1): cksource/ckeditor5-internal#411
* new Markdown demo: #8336
* adding and expanding "related features block" in a number of PRs: #8250

@godai78
Copy link
Contributor

godai78 commented Nov 6, 2020

How are we doing with the "new" / "extended" flag for the guides? This would also help draw attention to some features.

@godai78
Copy link
Contributor

godai78 commented Nov 19, 2020

I allowed myself to change the propose feature guide structure reflecting changes that are already introduced into a large number of the guides.

@godai78
Copy link
Contributor

godai78 commented Jan 13, 2021

We should revisit the #5588 idea for "all-features editor" (as far as this is available, OFC) and decide whether we put it in examples or on the features landing page.

@godai78
Copy link
Contributor

godai78 commented Mar 17, 2021

Also, this is a rather new implementation and an approach we should consider. This is the online html editor user-guide, which is user oriented, without any developer stuff: https://onlinehtmleditor.dev/user-guides/real-time-collaboration-editor/

We may consider expanding all docs with this kind of approach of: an introduction (existing) - user guide (to do) - developer info (existing) scheme, which would make it:

  • more user friendly,
  • prolly more discoverable (also sales-wise).

It would be a massive task, but parts of these are already written if we repurpose the existing guide and anyway this does not need to be a mammoth update, but can be introduced gradually (and also during other commits, as well).

Your opinions welcome. The job is partly done anyway for other purpose, so you can see and test it in real-life scenario (please disregard the CKE4 editor, tho).

@pomek pomek removed this from the nice-to-have milestone Feb 21, 2022
@apadol-cksource apadol-cksource added the resolution:resolved This issue was already resolved (e.g. by another ticket). label Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Epic resolution:resolved This issue was already resolved (e.g. by another ticket). squad:ccx Issue to be handled by the CCX team. 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

6 participants