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

Add code of examples #625

Closed
Reinmar opened this issue Oct 20, 2017 · 4 comments
Closed

Add code of examples #625

Reinmar opened this issue Oct 20, 2017 · 4 comments
Assignees
Labels
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 Oct 20, 2017

We knew how important this is for the developers but we didn't manage to add code examples to live examples.

I've just checked how many visits we had from various sources to this repo and the first referer is docs.ckeditor.com. From which pages precisely?

image

Yep, from examples. I wondered why and it gets clear when you see the website:

image

Basically, people hoped to see the code of these examples.

Let's fix this. We can do this in two steps:

  1. Let's add a short paragraph of text above/below each example with a link to the Quick Start guide saying that the user can find the source there.
  2. Let's work on wrapping examples with tabbed widget presenting "output", "HTML", "JS" and "CSS" if needed. A link to JSFiddle would actually be doable now too (in most of the examples), but to reduce the scope this can be done later.

@AnnaTomanek, could you handle the first part? Please also ping @m-turek so we publish the changes once they are done.

@Reinmar Reinmar added candidate:1.0.0 type:docs This issue reports a task related to documentation (e.g. an idea for a guide). labels Oct 20, 2017
@Reinmar Reinmar added this to the backlog milestone Apr 5, 2018
@Reinmar Reinmar modified the milestones: backlog, next Mar 18, 2019
@Reinmar
Copy link
Member Author

Reinmar commented Mar 19, 2019

#1608 (comment)

If we want to add the inspector to all demos of the editor in our docs, we should/could try to do that together with displaying the source code of these samples (reported in #625). Therefore, let's for now focus on mentioning the inspector in a couple of places, rather than on enabling it.

@Reinmar
Copy link
Member Author

Reinmar commented Apr 5, 2019

FYI: again request for source code 😄
Screenshot 2019-04-05 at 09 24 29

@godai78 godai78 self-assigned this Aug 20, 2021
@godai78 godai78 modified the milestones: nice-to-have, iteration 46 Aug 23, 2021
@AnnaTomanek AnnaTomanek added the squad:ccx Issue to be handled by the CCX team. label Aug 23, 2021
@AnnaTomanek AnnaTomanek removed this from the iteration 49 milestone Dec 7, 2021
@godai78
Copy link
Contributor

godai78 commented May 11, 2022

My suggestion is to follow suit and add the code of examples as we did for full-featured and bottom-toolbar examples.

Using the real code listing from the examples would make the editor (almost) immediately deployable hence of hight usability for integrators.

The said examples:

The code needs to be updated manually, but we have not come up with any ideas to automate it. The changes to examples are not that often and this is available.

Using actual example code means there is no need to re-test it, as this is an actual working code already.

Links to QS can still be added.

@CKEditorBot CKEditorBot added the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Jun 1, 2022
@Mgsy Mgsy closed this as completed Jun 13, 2022
@CKEditorBot CKEditorBot removed the status:in-progress Set automatically when an issue lands in the "In progress" column. We are working on it. label Jun 13, 2022
@godai78
Copy link
Contributor

godai78 commented Jun 13, 2022

Actually, there are still 3 examples without code in the Framework examples section, but these can be dealt with separately if we decided to add them.

@Mgsy Mgsy added this to the iteration 54 milestone Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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