Skip to Content Skip to Menu

🎃 Happy Halloween! Treat yourself with an awesome discount on memberships! Get 20% off now with code SPOOKY-2024!

Documentation

  • sentix
  • sentix
  • OFFLINE
  • Posts: 106
  • Thanks: 7
  • Karma: 0
11 years 1 week ago - 11 years 1 week ago #235703 by sentix
Documentation was created by sentix
I like the CB and CBSubs products. They are feature rich and very stable.

But: documentation is awful. I think I could get much more from tools like CBActions if these were better documented. Same is for the CB API where I cannot find anything anywhere. Also, a lot of files and docs is very old, related to prior versions of CB and is thereful useless.

What is your strategy on the documentation or did I miss something?

Versions: CB 2.7.2, J 3.10.6
Last edit: 11 years 1 week ago by sentix.
The following user(s) said Thank You: KatoKalin

Please Log in or Create an account to join the conversation.

  • KatoKalin
  • KatoKalin
  • OFFLINE
  • Posts: 265
  • Thanks: 11
  • Karma: -5
  • Add-ons
11 years 1 week ago #235704 by KatoKalin
Replied by KatoKalin on topic Documentation
@sentix: I do absolutely agree that the quality of the documentation provided is out of proportion to the quality of the products. There would be less support requests on the boards if everything would be well documented.

Please Log in or Create an account to join the conversation.

  • nant
  • nant
  • OFFLINE
  • Posts: 12339
  • Thanks: 1467
  • Karma: 877
11 years 1 week ago #235706 by nant
Replied by nant on topic Documentation

sentix wrote: I like the CB and CBSubs products. They are feature rich and very stable.

But: documentation is awful. I think I could get much more from tools like CBActions if these were better documented. Same is for the CB API where I cannot find anything anywhere. Also, a lot of files and docs is very old, related to prior versions of CB and is thereful useless.

What is your strategy on the documentation or did I miss something?


CB Documentation is in the advanced download area.

Is there something specific you feel needs to be improved here?

Please note that the CB documentation does not include descriptions of all other add-ons, its just meant to describe the core Community Builder suite.

CBSubs documentation is over 600 pages and it includes many use cases at various levels.
Is there something that you feel needs to me improved here?

CB Auto Actions I agree is a very powerful add-on that can be documented in depth. However such documentation cannot include basic html, javascript, php, jquery, css, SQL concepts that might be required and in most cases is in order to go the extra step.

This is why we try and help people on the forums and this is whay our forums are open for everyone to read.

Regarding CB Auto Actions there are a number of presentations and videos available:

www.slideshare.net/cbteam/presentations
vimeo.com/joomlapolis/videos

Please Log in or Create an account to join the conversation.

  • nant
  • nant
  • OFFLINE
  • Posts: 12339
  • Thanks: 1467
  • Karma: 877
11 years 1 week ago #235707 by nant
Replied by nant on topic Documentation

KatoKalin wrote: @sentix: I do absolutely agree that the quality of the documentation provided is out of proportion to the quality of the products. There would be less support requests on the boards if everything would be well documented.


Agree that things can always be improved.

You need to also agree that most support requests appear to be made without really studying the available documentation and without searching the forums before posting.

With CB 2.0 we are rethinking our entire documentation strategy and looking at better tools to organize things and make it easier for community to contribute also.

If you have any tool/environment proposals for us, by all means please propose.

Please Log in or Create an account to join the conversation.

  • KatoKalin
  • KatoKalin
  • OFFLINE
  • Posts: 265
  • Thanks: 11
  • Karma: -5
  • Add-ons
11 years 1 week ago #235711 by KatoKalin
Replied by KatoKalin on topic Documentation
Maybe you wanna check out this: docs.stackideas.com/developers
Also a real Wiki would be great and I believe easier to maintain. It would be uptodate immeadiately and it could be set that user can contribute code examples as well.

Please Log in or Create an account to join the conversation.

  • krileon
  • krileon
  • ONLINE
  • Posts: 48473
  • Thanks: 8281
  • Karma: 1443
11 years 1 week ago - 11 years 1 week ago #235752 by krileon
Replied by krileon on topic Documentation
Usage documentation for CB and CBSubs is fantastic. We are lacking a Developer documentation for sure, but we're discussing ways to improve this after CB 2.0. There also is for the most part no documentation for incubator projects, but when we do add Tutorials for incubator project usages you can find them below.

www.joomlapolis.com/support/tutorials

The problem with providing documentation for CB Auto Actions is it's basically impossible due to its purpose. The reason is it's just a tool. It doesn't do anything until you've told it to do something specific to your needs. So writing documentation to it would be only providing generic usecases, which you already have in our tutorial section above. It truly is a product that needs support interaction, which is fine and why I am here.

Right now we are trying to focus on bringing you a better CB and there's only so much we can do at once. So hopefully the community can bare with us as we try to improve on all things CB.

Also a real Wiki would be great and I believe easier to maintain.

We've been discussing something of the sort for after CB 2.0. Personally I'd like to have a Wiki that I can add tutorials for API usage and Incubator projects for the community to easily browse, but we've a few ideas going at the moment.

It would be uptodate immeadiately and it could be set that user can contribute code examples as well.

I'm not sure on user contributions. Probably would only allow this for specific approved users to avoid abuse. Everyone has an opinion on what should do what or how something should be done.


Kyle (Krileon)
Community Builder Team Member
Before posting on forums: Read FAQ thoroughly + Read our Documentation + Search the forums
CB links: Documentation - Localization - CB Quickstart - CB Paid Subscriptions - Add-Ons - Forge
--
If you are a Professional, Developer, or CB Paid Subscriptions subscriber and have a support issue please always post in your respective support forums for best results!
--
If I've missed your support post with a delay of 3 days or greater and are a Professional, Developer, or CBSubs subscriber please send me a private message with your thread and will reply when possible!
--
Please note I am available Monday - Friday from 8:00 AM CST to 4:00 PM CST. I am away on weekends (Saturday and Sunday) and if I've missed your post on or before a weekend after business hours please wait for the next following business day (Monday) and will get to your issue as soon as possible, thank you.
--
My role here is to provide guidance and assistance. I cannot provide custom code for each custom requirement. Please do not inquire me about custom development.
Last edit: 11 years 1 week ago by krileon.

Please Log in or Create an account to join the conversation.

Moderators: beatnantkrileon
Powered by Kunena Forum