How far to go

[wilsonge]

Do basic module and component tutorials come under the scope of this. Technically it does as a development resource. But actually (mainly because I've worked hard on them on there) the plugin and module resources on the wiki are pretty up to date. So I'm not sure if we need to put them in here - or just back into the wiki.

Personal preference is as it's done leave it on the wiki

(see https://github.com/eddieajau/joomla-developer-docs/issues/20)

[eddieajau]

Short answer is yes I think they belong and id like to scrape everything off the wiki in this regard. They probably fall under a cookbook or recipes super heading.

[dongilbert]

@eddieajau Can you hop on skype if you have some time? Want to discuss this and some other things. :)

[eddieajau]

So, I think the plan would be to identify anything of good quality and accurate on the docs wiki and port that across (put a redirect on the wiki). We could start by just finding everything related to modules because they are relatively easy and self-contained and that could set the stage for how we treat the other extension types. If that sounds like a plan, George, do you want to do up a todo issue for just that (scrape existing module content) and work out the steps involved?

Also, do you want to be on the curation team (be able to review pull requests) or do you just want to sit back with all care and no responsibility :)

[eddieajau]

Ok, here's an example of the landing page for recipes: http://developer.docs.joomla.org/#/en/cms/recipes.md

And an example recipe: http://developer.docs.joomla.org/#/en/cms/recipes/adding-custom-form-parameters-with-a-plugin.md

As for code snippets, see my question here: #18

[betweenbrain]

While I don't necessarily disagree with this initiative, I do have some concern with duplication of the Wiki and having yet another resource for information. The concern is that of basic fragmentation of knowledge within the community.

With that in mind, is it possible that the Wiki be the source of information and this populated by the scraper?

Short answer is yes I think they belong and id like to scrape everything off the wiki in this regard. They probably fall under a cookbook or recipes super heading.

[eddieajau]

@betweenbrain my vision is that all developer content is moved out of docs.joomla.org and into developer.docs.joomla.org. There is no point in keeping two copies.

In terms of someone viewing and searching for content, there is virtually no difference, in fact, the site could be skinned to look very similar. The major difference would be that someone making a change to end-user documentation registers on the Mediawiki and uses a WYSIWYG editor to make their changes. For developer docs, you would be directed to Github, where you more than likely already have an account and you'd use pure Markdown to make the changes.

[wilsonge]

Hi Andrew, Sorry for late reply - been running around like a mad hatter :) So one of the things I've not got round to trying out on the wiki - but I think we should be looking to do here from the off for tutorials is to assign difficulty levels. So new people are shown basic modules. Medium users perhaps plugins and complex modules then more advanced people get components.

I'll try my best to scrape the module tutorial and have a play around. What section would this be going under?

RE: Mediawiki vs GitHub - I personally think especially for the more basic developer docs people may prefer a WYSIWYG editor to a markdown format for editing. Certainly we need to have a prominent link to the github wiki markdown cheat sheet.

RE: PR permissions. sure I'm happy to help out with it. As you can probably tell uni occupies a lot of my time these days so no guarantees on the time I can put into this though

[eddieajau]

What section would this be going under?

Maybe under /cms/extensions/modules/ ?

I personally think especially for the more basic developer docs people may prefer a WYSIWYG

As someone who writes a LOT of developer documentation, I love the simplicity of markdown. It's very Zen.

As you can probably tell uni occupies a lot of my time these days

This is a long term project and I understand life gets in the way. It's going to take a long time to spin up the flywheel and gain momentum anyway. I'll add you to the team. Thanks!

[poproar]

I am a bit nervous to butt-in but I would just like to state that it makes the most sense to me that developer documentation be here. It is heavily encouraging as a developer regardless of my skill or knowledge level to be pushed to work in git. I have for years driven myself to the mad hatter's tea party hunting through the mediawiki. It has improved greatly but the are too many holes and I often end up referring to api.joomla.org only to be discouraged that there are no examples like on php.net or similar. I think the docs are great for users but I also agree that users would benefit from it being done with joomla itself although as I have seen Andrew indirectly mention that it is a great deal of more work. I know all these things have been said in the past but I just want you guys to know I am eager to see this thing continue.

[pbwebdev]

I feel like a kid jumping in halfway through a movie and commenting at this point but I have to agree with Poproar's comment there about the examples that are found on PHP.net as well as the user submitted examples. I found I did a lot of learning in the early days off the back of all of those examples and still refer to them as I just don't remember certain aspects as I don't code everyday.

Did I just make the strong longer?

[eddieajau]

Don't ever be nervous about butting in :)