search

TYPO3-Documentation / T3DocTeam

This repository is for the Documentation Team. To contribute, please see CONTRIBUTING.md For help and support on TYPO3, please see: https://typo3.org/help/
3 stars 1 forks source link

Continue with CKEditor docs #25

Closed marble closed 5 years ago

marble commented 6 years ago

Riccardo De Contardi has started. Now we need to find out how to continue best.

From Slack Jul 14, 2018: https://typo3.slack.com/archives/C028JEPJL/p1531580665000030

Riccardo De Contardi [5:04 PM] Hello guys. I've just finished to write down my findings about CKEditor plugins here https://docs.typo3.org/typo3cms/drafts/github/T3DocumentationStarter/Public-Info-002/HelloWorld/Index.html This is far from finished, but it is the best I can do... Apart from formatting (I'm not sure that everything is ok) there are at least two great issues to solve

Martin Bless [7:25 PM] @riccardodecontardi Thank you very much. Great, that you managed to do that in that starter project. I'll look at it and then find a way for the next steps.

Riccardo De Contardi [9:04 PM] @martin.bless let me know if I can help

Martin Bless [9:05 PM] didn't start yet

sypets commented 6 years ago

@marble @Riccardo Please note that there is already a forge issue for documenting rte_ckeditor: https://forge.typo3.org/issues/85461

See also what Benni wrote about what should go in system extension docs (in core) and what in Core API (see the forge issue).

There is a DRAFTs area for rte_ckeditor, which could be used to work on it: https://docs.typo3.org/typo3cms/Teams/T3DocTeam/Drafts/rte_ckeditor/rte_ckeditor/Documentation/Index.html

It can then be used for a core patch.

If you don't want to use the DRAFTS area, just delete it or let me know and I'll delete it.

Benni already wrote some notes for rte_ckeditor. I think @DanielSiepmann said he will start to convert them to reST.

I think it would be a good idea to finish a minimal version (so that we will finally have some documentation at all) and work on more extensive changes in another patch.

DanielSiepmann commented 6 years ago

The work of benni is available at https://docs.google.com/document/d/13C9qi3NR2KJikX9ziGg1Pkg59bLR_JwC9yz6YpA6v54/edit?usp=sharing

DanielSiepmann commented 6 years ago

Next steps would be to export the drive document as open office, to migrate it to restructured text via the rendering toolchain. The result will be merged with Riccardos work.

The generated extension manual draft will be rendered in the draft area of docs.typo3.org. Afterwards someone else from the community can jump in and improve the state of the documentation.

This can then be merged to TYPO3 CMS repository as documentation of the system extension.

marble commented 6 years ago

From the Etherpad https://notes.typo3.org/p/T3DocTeam-Sprint-2018-07-2

Somebody wrote:

sypets commented 6 years ago

As mentioned in the issue (https://forge.typo3.org/issues/85461?next_issue_id=85456), the text by Benni should be split up:

Benni: "I propose this:

  1. Base Principles of RTEs and transformations, yaml configuration concepts in Core API:RTE
  2. integration of CKEditor into extension manual ("how do i set up a custom CKEditor module etc")"
sypets commented 5 years ago

Patch is in review: https://review.typo3.org/c/59627/

About the patch:

Even though there is still work to be done, I believe the patch is mergable in its current form.

sypets commented 5 years ago

This is pretty much done. See:

Still open: PR for adding link in "Tell me Something About": https://github.com/TYPO3-Documentation/TYPO3CMS-TellMeSomethingAbout/pull/9