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
Documentation #150
Comments
More varia stuff:
|
@Reinmar: Amended "Varia" with your suggestions. |
We've been talking with @fredck about releasing CKEditor 5. The biggest cost of releasing CKE 4 is ensuring that there are no broken samples. There's a huge test suite for the code which helped us catching nearly all regressions, but we didn't have anything for samples. CKEditor 5 samples will be used in at least 2 critical places: its website and in the documentation (which consists of samples and other code listings). Possibly, also in other places, like a sample shipped in some packages (if we'll keep those). With time the number of samples may grow high above CKE 4's, because coding features for CKE 5 is much easier. We clearly need to automate the process of testing them. Initially, we thought about a repository with CKE 5's samples, which we'd simply test using Bender. Each sample would have an HTML, JS and test files. Then, the documentation would use all those samples and also the website would include some samples directly from this repository. I'm afraid though, that we oversimplified this. There are couple of things that we need to consider:
PS. As for shipping CKEditor bundles with at least one sample, that's tricky too... Specific project configurations (like – I want these |
+1 I think it is better to have a single place with all samples. |
@postJScriptum sent me a link to http://redux.js.org/ which is built on https://www.gitbook.com/. We won't be able to use the engine, but I like the Redux docs very much so we can get some ideas from it. |
When we've been talking with @wojtekidd about what CKEditor 5 is ("a framework with ready-to-use solutions build on top of it") we independently started thinking about the structure of documentation. The idea is to split documentation into two main use cases "framework" and "solutions". This can still be one page, but its structure could be defined by these two categories. I think this is an interesting idea. Those two groups of developers have very different needs and following this convention we may be able to create two sites where none of them will be overloaded with partially useless stuff. Especially for the group looking for ready-to-use solution this will be a better experience, because the documentation will not be that overwhelming. WDYT? |
Cleaning up old discussions. See #186. |
This is a summary of ideas and requirements for the CKEditor 5 documentation project.
Target
Delivery
A single website containing the following main sections:
Software
It may happen that different software solutions will be used to produce the different kinds of documentation predicted. The following are basic requirements:
Source Documentation
Core repos as well as plugins will have their own documentation, which will be then unified on documentation build. This must allow for custom plugins to be as well documented.
Samples
Building
Specific gulp tasks should be available to build the documentation site. Hopefully relative linking will be enforced so the documentation is navigable locally.
Varia
The text was updated successfully, but these errors were encountered: