Port documentation to rst about ext-solr HOT 22 CLOSED

Once this is done, remove reference to forge in README.md

from ext-solr.

I will take care of this. I've already started, but it might take a while until I'm finished.

from ext-solr.

@peterkraume any updates?

from ext-solr.

I was on holidays the last two weeks. Expect progress within the next two weeks.

from ext-solr.

ok cool, thx

from ext-solr.

@irnnr here is the progress I've made so far. Unfortunately it's way more work than I expected but I'm gaining speed.

The current status can always be found here:
http://solrdoku2rst.dev.dasrv5.de/Index.html
Basic Auth protection: web/web

Please let me know, what you think, especially about the TypoScript Reference.
http://solrdoku2rst.dev.dasrv5.de/ConfigurationReference/TypoScript/Index.html

from ext-solr.

The source code is available here:
https://github.com/peterkraume/ext-solr/tree/documentation/Documentation

from ext-solr.

Thanks for your efforts Peter!
Regarding the TS reference I would suggest to simply stay with the formatting as in the current wiki. That seems to be a lot simpler to write and more importantly easier to read. I'm not sure where the t3o online documentation styling is heading but I think the current table-style reference is not the best choice in terms of usability and readability.

Let me know if you have an opinion on that.

from ext-solr.

I'd prefer to stick with the "official" way to write TS documentation because people are used to it and many other extension documentations (e.g. EXT:news) use this way of documentation. I'm aware of the fact that this will mean a lot of additional work for me, but that's ok.

from ext-solr.

Please do not use those tables, just because it's official doesn't mean it's good. The current format has worked well for us.

from ext-solr.

Well, I didn't say it's good! I just said that it's a standard for TYPO3 documentation and widespread. I'm not a big fan of doing things different from the standard.

from ext-solr.

I think its good to have documentation that would come with the extension. I wonder if we could derive from markdown to ReST?

from ext-solr.

@dkd-dobberkau That's the point, rest will ship with the extension and is a readable text format already. GitHub does render it, too.

@peterkraume Another point against those tables: GitHub does not render them as on t3o. We can also discuss this in a Skype/Hangout/video session, I feel like text is not the right medium.

from ext-solr.

What is the status on this issue? Can i support somewhere?

from ext-solr.

Well, I was in discussions with @irnnr and @dkd-dobberkau about the format, but that's still undecided.

from ext-solr.

so how do we get to a next step here folks?

from ext-solr.

We will have documentation in reST and there's a branch already where I've started moving pages from the wiki to reST.

https://github.com/TYPO3-Solr/ext-solr/tree/documentation-rst

from ext-solr.

Probably will have to pull some of @peterkraume's fork to finish it.

from ext-solr.

what is the status of this issue?
are you going to move the documentation to an own github repository and sync it with ter?
support needed?

from ext-solr.

Sorry guys, I'm currently not able to contribute to the documentation. Feel free to take all you need from my fork: https://github.com/peterkraume/ext-solr/tree/documentation

from ext-solr.

@martinhummer the documentation will leave in Documentation subfolder following TYPO3 best practice.

Currently you can contribute by forking and migrating the current documentation from forge to rst.
Also new and updated parts are welcome of course.

You can also take a look at @peterkraume 's fork and check what's missing or can be provided as a pull request to this main repository.

from ext-solr.

Closing the issue. Documentation was merged with #465

from ext-solr.