What Documentation / Tutorials would you like to see?

Numero uno on my list is how to create a mulit-lingual site. There are a few methods of doing this on Evo, but none yet on Revo.

Quote from: planner at Mar 14, 2010, 03:19 PM

Numero uno on my list is how to create a mulit-lingual site. There are a few methods of doing this on Evo, but none yet on Revo.

Look into contexts. I have read multiple posts where people are using contexts to switch lexicons, and resources to address individual language sets.

I would HIGHLY appreciate clickable links in EVERY snippet installed via the repo or package manager back to a wiki and / or this forum and/or developers site.

I just pulled off some cool stuff with the if snippet, but does ANYONE here have any IDEA on how HARD it is to search for "if"?

We need to move past "read the code for instructions on how to use this snippet".

Just my opinion.

Quote from: wshawn at Mar 19, 2010, 03:49 PM

I would HIGHLY appreciate clickable links in EVERY snippet installed via the repo or package manager back to a wiki and / or this forum and/or developers site.

I just pulled off some cool stuff with the if snippet, but does ANYONE here have any IDEA on how HARD it is to search for "if"?

We need to move past "read the code for instructions on how to use this snippet".

Just my opinion.

Wouldn’t we all! This would be great. I think the documentation’s getting a whole lot better, but it takes the whole community to make it happen. If we all chip in and contribute what we know and are learning to the wiki and/or just document what we’re learning in then we’d be helping the developers a lot in getting information out there. They’re busy developing, let’s get busy helping!!

The + sign in the PM grid used to show the readme.txt file, but I think it now shows the description entered when you upload the package (could be wrong).

Maybe we need a "links" component for packages that could be extracted and shown there below the description or something similar. As a short-term solution, we could put a message on the upload page suggesting that the description include links to any documentation.

I reported virus/spam infected websites in the repository and think
that resulted in removing of all "visit developer site" links...

Quote from: wshawn at Mar 19, 2010, 03:49 PM

I would HIGHLY appreciate clickable links in EVERY snippet installed via the repo or package manager back to a wiki and / or this forum and/or developers site.

I just pulled off some cool stuff with the if snippet, but does ANYONE here have any IDEA on how HARD it is to search for "if"?

We need to move past "read the code for instructions on how to use this snippet".

Just my opinion.

Well, all the major add-ons are going to hopefully be in documentation:

http://svn.modxcms.com/docs/display/ADDON/AddonName

so, If, whenever we get around to writing the docs for it, would be:

http://svn.modxcms.com/docs/display/ADDON/If

Pretty standard, eh?

However, we restrict the ADDON space from public editing - you have to ask us for access first. Usually we give this to Add-On developers, although there is exceptions. If you’d like access and plan on contributing to docs, just contact me via PM.

Quote from: einsteinsboi at Mar 19, 2010, 04:01 PM

Wouldn’t we all! This would be great. I think the documentation’s getting a whole lot better, but it takes the whole community to make it happen. If we all chip in and contribute what we know and are learning to the wiki and/or just document what we’re learning in then we’d be helping the developers a lot in getting information out there. They’re busy developing, let’s get busy helping!!

By the way, if someone has signed a CLA and either:
a) developed a relationship with the MODx team
b) written good documentation in the ADDON space

then we consider giving them access to the official documentation. We just restrict it to keep the info accurate.

However, if anyone’s interested in helping out, we’d love to know. Just PM/email me directly.

Quote from: splittingred at Mar 19, 2010, 04:46 PM

Quote from: einsteinsboi at Mar 19, 2010, 04:01 PM

Wouldn’t we all! This would be great. I think the documentation’s getting a whole lot better, but it takes the whole community to make it happen. If we all chip in and contribute what we know and are learning to the wiki and/or just document what we’re learning in then we’d be helping the developers a lot in getting information out there. They’re busy developing, let’s get busy helping!!

By the way, if someone has signed a CLA and either:
a) developed a relationship with the MODx team
b) written good documentation in the ADDON space

then we consider giving them access to the official documentation. We just restrict it to keep the info accurate.

However, if anyone’s interested in helping out, we’d love to know. Just PM/email me directly.

Signed a CLA but haven’t had time to fax it in... have to go to Fedex since I don’t have a fax at home, and I don’t have stamps... darn I sound a little pathetic... lol

Quote from: einsteinsboi at Mar 19, 2010, 04:57 PM

Signed a CLA but haven’t had time to fax it in... have to go to Fedex since I don’t have a fax at home, and I don’t have stamps... darn I sound a little pathetic... lol

Do you have a scanner? We take scanned CLAs.