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

[Docs] Promote CKE5 inspector #1608

Closed
Reinmar opened this issue Mar 7, 2019 · 7 comments
Closed

[Docs] Promote CKE5 inspector #1608

Reinmar opened this issue Mar 7, 2019 · 7 comments
Assignees
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Milestone

Comments

@Reinmar
Copy link
Member

Reinmar commented Mar 7, 2019

@oleq developed this amazing tool, we started using it and now it's time to promote it in the docs.

The minimum will be to mention it in a separate page and link to this page from some other pages (e.g. quick start, arch intro, etc.).

What would be much cooler, is if we enabled the inspector for the samples that are in the docs. However, this'd require some nice UI cause we cannot just show it to everyone.

@Reinmar Reinmar added this to the iteration 23 milestone Mar 7, 2019
@Reinmar Reinmar added the type:docs This issue reports a task related to documentation (e.g. an idea for a guide). label Mar 7, 2019
@scofalik
Copy link
Contributor

scofalik commented Mar 7, 2019

I think the link is incorrect :P.

@Reinmar
Copy link
Member Author

Reinmar commented Mar 7, 2019

Good that I didn't paste my banking site password ;)

@Reinmar
Copy link
Member Author

Reinmar commented Mar 19, 2019

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 Mar 19, 2019

  1. Add "Development tools" below "Quick start" in the Framework section of the docs. Note: It may also be a good time to split "Quick start" into two parts: "QS" and "Implementing a simple plugin". Then, "Development tools" could be a continuation of those two guides.

  2. What should be covered in "Development tools"?

    • the inspector (adding it to the setup created in previous guides)
    • setData/getData (view/model) utils (note: there's already a section about those things in the block widget tutorial)
    • whatever else that we find useful during development (ask guys).
  3. In which other places we could mention the inspector?

  4. Let's add the inspector to CDN under https://cdn.ckeditor.com/ckeditor5/12.0.0/inspector.js. In the docs we can show using it from CDN and npm. cc @vokiel

@Reinmar
Copy link
Member Author

Reinmar commented Mar 19, 2019

4. Let's add the inspector to CDN under https://cdn.ckeditor.com/ckeditor5/12.0.0/inspector.js. In the docs we can show using it from CDN and npm. cc @vokiel

Actually, it'd be good to somehow automate this (or grant one of us the rights to publish there) because we're releasing the inspector more often than we release CKE5.

@vokiel
Copy link
Contributor

vokiel commented Mar 19, 2019

What about updating the lib on the server after 'Release published.' webhook?

@Reinmar
Copy link
Member Author

Reinmar commented Mar 19, 2019

The only problem I see with this is where to get the built version of this lib from. It'd have to be installed from npm. Where would we run this script?

oleq added a commit to ckeditor/ckeditor5-alignment that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-basic-styles that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-ckfinder that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-font that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-heading that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-highlight that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-image that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-link that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-media-embed that referenced this issue Mar 20, 2019
oleq added a commit to ckeditor/ckeditor5-table that referenced this issue Mar 20, 2019
Reinmar added a commit to ckeditor/ckeditor5-alignment that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-font that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-basic-styles that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-ckfinder that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-heading that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-highlight that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar pushed a commit to ckeditor/ckeditor5-image that referenced this issue Mar 25, 2019
Reinmar added a commit to ckeditor/ckeditor5-image that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-link that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar pushed a commit to ckeditor/ckeditor5-media-embed that referenced this issue Mar 25, 2019
Reinmar added a commit to ckeditor/ckeditor5-media-embed that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Reinmar added a commit to ckeditor/ckeditor5-table that referenced this issue Mar 25, 2019
Docs: Added an info box recommending the CKEditor 5 inspector to the feature guide (see ckeditor/ckeditor5#1608).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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

4 participants