Ckeditor4: Improve visibility on npm

Created on 19 Apr 2018 · 19Comments · Source: ckeditor/ckeditor4

Are you reporting a feature request or a bug?

Task

Provide detailed reproduction steps (if any)

On https://www.npmjs.com/package/ckeditor I can see that we have a "richtext" keyword. From what I saw, it's not going to match with "rich-text editor" phrase because npm does a rather bad job at fuzzy matching them. It's good to be explicit. We have both "rich-text" and "richtext" in CKEditor 5, but I'm thinking now that perhaps it'd be even better to have "rich", "text", "editor" – all separate. Although... if "rich-text" query will be treated as a single word then it may not match "rich" + "text"... :D

skip task

Source

Reinmar

All 19 comments

One more thing, in fact. Check out the quality and maintenance indexes:

Why does ckeditor-dev gets more? Because its repository points to this repo. And ckeditor's to the ckeditor-releases in which there are barely any issues.

I think that it'd be good to point to this repository from both packages. Regardless of the fact from where the release really happen.

Reinmar on 19 Apr 2018

CC @wojtekidd

wwalc on 19 Apr 2018

Do whatever you feel is suitable for npm.

wojtekidd on 19 Apr 2018

😄1

It make sense to switch to a common repo.

As for keywords "rich text" seems to match "rich-text", "rich text" but not "richtext" - so thinking like that we would need rich text and richtext.

mlewand on 19 Apr 2018

As for keywords "rich text" seems to match "rich-text", "rich text" but not "richtext" - so thinking like that we would need rich text and richtext.

Unfortunately yes, that's why in case of CKEditor 5 we need to use "ckeditor", "ckeditor 5" and "ckeditor5" keywords together.

If not the issue title, I'd report it as a separate ticket, but since it's about Improving the visibility on npm...

I believe the scope of this ticket is much wider than correcting keywords, it should include:

Creating separate readmes for NPM, that focus more on selling the product (using keywords that we want to promote on @wojtekidd) and on developer experience installing the editor from NPM, than about the structure of the GitHub repository. For example one does not know exactly what will be installed by npm i ckeditor - the readme is completely confusing there. The copies of GitHub readme do not fit there completely. In other projects we decided to start using README.release.md to be used during deployment to npm and it seems like the right strategy here.
Updating release scripts to make sure the correct readme is deployed.
Using the right keywords.

In other words, it would be great if the information displayed e.g. here:

contained valuable, contextual information, for people, for who, this is an entry point to the editor.

wwalc on 19 Apr 2018

Dooh. This is bad: https://www.npmjs.com/package/ckeditor-releases We need to take it over.

wwalc on 19 Apr 2018

😕1

DO READ https://npms.io/about

Reinmar on 23 Apr 2018

I have pushed the draft to https://github.com/ckeditor/ckeditor-dev/blob/t/1903/.npm/README.md

Must haves:

We need a screenshot. The question here is what toolbar should we use. I'd go with the _default_, as if we go with customized/reduced people might get confused after installation that this is a completely different thing.
The text needs to be reviewed.
Keywords checked.
Checking on how to change the README.md for npm alone. If not possible, then we need adjust building scripts.

Nice to haves:

I was thinking that it could be nice to mention, and link to CKEditor 5.

And here's how it would look like today:

mlewand on 27 Jul 2018

I've added some minor changes.

wojtekidd on 30 Jul 2018

I was thinking that it could be nice to mention, and link to CKEditor 5.

Actually we might do reference CKE4 in CKE5 npm readme to decrease any possible confusion.

Just two simple lines like:

If you are looking for CKEditor 5, here's a link to the relevant npm package: https://www.npmjs.com/package/ckeditor5

Find out more about differences between CKEditor 4 and CKEditor 5.

wojtekidd on 30 Jul 2018

I added these last modifications to the readme:

Added CKE5 link, @wojtekidd please verify that I decided to put just a link to CKE5 npm package. I think second link is redundant here and if anything, it should be mentioned in CKE5 readme for the time being.
Changed the preset information (for dev it's full preset).
Removed stray Keywords section - npm adds it automatically

Now the only thing that we're missing here is the image. @RyszardB could you create one?

Also @wwalc asked me whether there's a different version for the CKE4 release pacakge (as opposed to dev). I find we need only one difference there: the preset that is provided by package. For dev version it's full-all for release version that's standard-all.

Other than that installation steps and any other points are the same, so let's keep it simple.

mlewand on 9 Aug 2018

@wojtekidd please have a final look at the readme, and confirm that everything looks good.

As for screenshots, I believe we need to show the editor that given package contains - I especially mean the preset.

So for ckeditor-dev that would be full preset, and for release the standard preset.

And I know… it stinks, as it will require us to include the full toolbar in the screenshot for ckeditor-dev. It will be better for the default editor. However I think it is important to show on the screenshot exactly what you get by downloading the package.

mlewand on 9 Aug 2018

👍1

It is really important to explain what one in ckeditor-dev gets, because this distribution is in fact a bit useless (unless one really knows what he is doing). Accidentally, by making a nice readme for it and posting a screenshot of a full preset, we may cause that it will have a larger number of accidental downloads than today, just because one will start thinking that in this package he will get color buttons and stuff like that.

As a consequence, some unaware people may download it "to have more buttons" and then complain that it is very slow or just stop using it because of the slowness.

So ckeditor-dev should have some text explaining what's the purpose of this package and for who it's targeted. Also the user should be linked to other places where he can find "build" distributions of CKEditor, especially where one can find builds with "more buttons" and/or hints/links on how to create one.

wwalc on 9 Aug 2018

full preset??? where can I find an example of the full preset and moono-lisa skin?

my proposition:

RyszardB on 10 Aug 2018

@RyszardB it's http://cdn.ckeditor.com/4.10.0/full/samples/

mlewand on 10 Aug 2018

RyszardB on 10 Aug 2018

The screenshot content is confusing - I understand the intentions, but in fact, none of it is included in the ckeditor-dev package. Hundreds of add-ons are in the add-ons repo, unavailable on npm, and both EI and CKF are paid products.

@RyszardB
Please use the content from one of the existing demos, with an image etc. Something that would simply look good, like https://ckeditor.com/ckeditor-4/#article