Opened 11 years ago

Closed 10 years ago

#2794 closed New Feature (fixed)

V3: Include INSTALL.html with basic installation instruction

Reported by: Frederico Caldeira Knabben Owned by: Frederico Caldeira Knabben
Priority: Normal Milestone: CKEditor 3.0
Component: General Version:
Keywords: Confirmed Review+ Cc:

Description

A file named INSTALL.html should be available at the root of our distribution, containing basic installation instructions, pointing to our documentation more information.

Attachments (3)

2794.patch (2.2 KB) - added by Martin Kou 11 years ago.
2794_2.patch (3.0 KB) - added by Frederico Caldeira Knabben 10 years ago.
2794_3.patch (3.0 KB) - added by Frederico Caldeira Knabben 10 years ago.

Download all attachments as: .zip

Change History (11)

comment:1 Changed 11 years ago by Martin Kou

Owner: set to Martin Kou
Status: newassigned

Changed 11 years ago by Martin Kou

Attachment: 2794.patch added

comment:2 Changed 11 years ago by Martin Kou

Keywords: Review? added

comment:3 Changed 11 years ago by Alfonso Martínez de Lizarrondo

Keywords: Review- added; Review? removed

The file is missing the closing </html>

I'm not sure that the step to download the zip is really needed: if the file is inside the distribution, we can guess that he probably has already downloaded it.

Also, this is provided with the rest of files, so we can add some links to the _samples (not just a reference to look it up in his server) and _docs (as it does contain so much info that the user doesn't need to read in the wiki)

I would add more emphasis on the fact that the user must look at the samples and read the wiki in order to learn how to use it. For any newcomer the current content of the file is almost "rubbish", it doesn't explain how to really use CKEditor, how to create an instance, fill its default value, read the changes, use it from the server, use the API...

Also it might be important to highlight that this is meant to be used with a server, this isn't a desktop utility to edit html files (the 'where's the .exe?' question)

comment:4 Changed 11 years ago by Artur Formella

Yes. User doesn't know many things:

-instance = editing field

-what is CKEDITOR

-how to set config (in config.js, inline)

-code is packed (source code is somewhere else)

comment:5 Changed 11 years ago by Frederico Caldeira Knabben

@arczi : This file is supposed to have only basic installation instructions. It's not the documentation for CKEditor.

Changed 10 years ago by Frederico Caldeira Knabben

Attachment: 2794_2.patch added

comment:6 Changed 10 years ago by Frederico Caldeira Knabben

Keywords: Review? added; Review- removed
Owner: changed from Martin Kou to Frederico Caldeira Knabben
Status: assignednew

Changed 10 years ago by Frederico Caldeira Knabben

Attachment: 2794_3.patch added

comment:7 Changed 10 years ago by Artur Formella

Keywords: Review+ added; Review? removed

Looks good but the link to the documentation is a bit confusing.

comment:8 Changed 10 years ago by Frederico Caldeira Knabben

Resolution: fixed
Status: newclosed

Fixed with [3892].

Note: See TracTickets for help on using tickets.
© 2003 – 2019 CKSource – Frederico Knabben. All rights reserved. | Terms of use | Privacy policy