joomla/Component-Builder

Fork 11

Knowledge Base Development #356

New Issue

Open

opened 2018-11-22 21:13:43 +00:00 by peterpetrov · 7 comments

peterpetrov commented

2018-11-22 21:13:43 +00:00

(Migrated from github.com)

Hey Llewellyn, i sure you have considered it so i would ask if you have already KB somewhere that would need updating with step by step articles for how to use JCB and its functions. If there is one please let me know how do you like it written so i can join there and write some articles.

Llewellyn commented

2018-11-22 22:27:35 +00:00

There is stuff being done. @joejvggithub has really taken the lead on some of the projects. You will see the wiki has been undergoing changes. The last idea was to convert all the video tutorials into text.

I helped speed up this processes and so all the tutorials are now in text but un-formatted so if you would like with formatting the text and adding it to the wiki you are welcome to do that. Just communicate with Joe so to avoid working on the same files 👍 ( also want to add the text to the videos... but for that we will need to make use of some more advanced tools... if interested let me know) I actually have all the tools to do this just not the time....

Yet if you want to instead contribute a workflow of some kind, the floor is open. You can use the wiki, and we can at some point move it to its own repo and convert it to a github pages or something... should not be that hard.

There is not much conventions in place regarding the KB. But I would imagine we can discuss things as needed.

For now the format is markdown, and the place is the local github wiki, I would like to change the landing page to serve as a easy point of access to all that has been done.

You do realize my way has been video tutorials... but not everyone has the time or will to watch so many hours... and there is still so much that has not been said. So a KB is needed for sure.

There is stuff being done. @joejvggithub has really taken the lead on some of the projects. You will see the [wiki](https://github.com/vdm-io/Joomla-Component-Builder/wiki) has been undergoing changes. The last idea was to convert all the video tutorials into text. I helped speed up this processes and so all the tutorials are now in [text but un-formatted](https://drive.google.com/drive/folders/1i-5nj-HHBH-hdjvl2KWB5c8QVJ8Z2T5s?usp=sharing) so if you would like with formatting the text and adding it to the wiki you are welcome to do that. Just communicate with Joe so to avoid working on the same files :+1: ( also want to add the text to the videos... but for that we will need to make use of some more advanced tools... if interested let me know) I actually have all the tools to do this just not the time.... Yet if you want to instead contribute a workflow of some kind, the floor is open. You can use the wiki, and we can at some point move it to its own repo and convert it to a github pages or something... should not be that hard. There is not much conventions in place regarding the KB. But I would imagine we can discuss things as needed. For now the format is markdown, and the place is the local [github wiki](https://github.com/vdm-io/Joomla-Component-Builder/wiki), I would like to change the landing page to serve as a easy point of access to all that has been done. You do realize my way has been video tutorials... but not everyone has the time or will to watch so many hours... and there is still so much that has not been said. So a KB is needed for sure.

peterpetrov commented

2018-11-22 22:43:05 +00:00

(Migrated from github.com)

Thanks. I guess the question here is how to make it simple enough and not copying much of the actual Joomla documentation into it.I will get in touch with Joe and see what we can come up with.

👍 1

Llewellyn commented

2018-11-22 23:11:41 +00:00

Well try to think about things this way... there is the GUI, where we store the data and then there is the compiler and then there is the actual Joomla Component package and its code structure.

The GUI is a way to separate your component (structure and ideas) form the Joomla API and so if Joomla changes we want to with little effort update all components, by just updating JCB.

So to me the first step must be to help developers see the JCB-GUI as a storage container of their idea. The idea then via JCB-compiler gets converted into reality the Joomla Component.... lol look at me getting all philosophical, that is not intended. I am just meaning to say custom scripting must always be the last option. If JCB as a way to do it we should encourage them to use it instead, since this will help with the original purpose of JCB. Which must be easy maintainability of your components.

So to first explain the GUI in the most simplest of terms (to help them see how to store the idea), and then leave little links/paths to the more advanced expansion options of custom scripting. You see even here custom scripting has evolved. I am find myself moving more and more code out of the normal custom scripting areas around the views and components other areas and replacing them with custom-code placeholders and reusing them all over many components. So custom coding must jump out of the normal add PHP area, into custom-code with placeholders and therefore a type of inheritance of re-usability.

So to first build an over view of the JCB GUI integration possibilities and then expand or deepen into the various areas and tremendous freedoms of encapsulation.

But yes I feel like you guys who had to without proper documentation get going, and has actually been able to get JCB to work for you, may have a better angle as to what will help new comers easily emerge their ideas to a JCB implementation of thought.

Well try to think about things this way... there is the GUI, where we store the data and then there is the compiler and then there is the actual Joomla Component package and its code structure. The GUI is a way to separate your component (structure and ideas) form the Joomla API and so if Joomla changes we want to with little effort update all components, by just updating JCB. So to me the first step must be to help developers see the JCB-GUI as a storage container of their idea. The idea then via JCB-compiler gets converted into reality the Joomla Component.... lol look at me getting all philosophical, that is not intended. I am just meaning to say custom scripting must always be the last option. If JCB as a way to do it we should encourage them to use it instead, since this will help with the original purpose of JCB. Which must be easy maintainability of your components. So to first explain the GUI in the most simplest of terms (to help them see how to store the idea), and then leave little links/paths to the more advanced expansion options of custom scripting. You see even here custom scripting has evolved. I am find myself moving more and more code out of the normal custom scripting areas around the views and components other areas and replacing them with custom-code placeholders and reusing them all over many components. So custom coding must jump out of the normal add PHP area, into custom-code with placeholders and therefore a type of inheritance of re-usability. So to first build an over view of the JCB GUI integration possibilities and then expand or deepen into the various areas and tremendous freedoms of encapsulation. But yes I feel like you guys who had to without proper documentation get going, and has actually been able to get JCB to work for you, may have a better angle as to what will help new comers easily emerge their ideas to a JCB implementation of thought.

Llewellyn commented

2018-12-19 19:49:34 +00:00

@joejvggithub I just had a look at what you did in the wiki, specially the Field Types and it look stunning!

@joejvggithub I just had a look at what you did in the wiki, specially the [Field Types](https://github.com/vdm-io/Joomla-Component-Builder/wiki/005-Field-Types) and it look stunning!

Llewellyn commented

2018-12-19 20:12:45 +00:00

Just a few suggestions, I will add all the text and would like to set a few standards.

One we will number them with a three number notation, no dots and only the actual correct title, so that if any system uses these files, that have a consistent link name, like:

https://github.com/vdm-io/Joomla-Component-Builder/wiki/005-Field-Types

and not:

https://github.com/vdm-io/Joomla-Component-Builder/wiki/5-.-Field-Types-(ready)

Which will change again and again, but instead a constant 005-Field-Types that will not easily change again.

Then I was wondering, I see the option of (work in progress) as the first notation on the file, lets other know you are working on it. Once this is removed, and the file has clearly been edited we know it is ready, and only in need of minor edits as needed.

@joejvggithub and @peterpetrov please feel free to let me know of any other ideas you may have to guide this work.

Just a few suggestions, I will add all the text and would like to set a few standards. One we will number them with a three number notation, no dots and only the actual correct title, so that if any system uses these files, that have a consistent link name, like: ``` https://github.com/vdm-io/Joomla-Component-Builder/wiki/005-Field-Types ``` and not: ``` https://github.com/vdm-io/Joomla-Component-Builder/wiki/5-.-Field-Types-(ready) ``` Which will change again and again, but instead a constant `005-Field-Types` that will not easily change again. Then I was wondering, I see the option of `(work in progress)` as the first notation on the file, lets other know you are working on it. Once this is removed, and the file has clearly been edited we know it is ready, and only in need of minor edits as needed. @joejvggithub and @peterpetrov please feel free to let me know of any other ideas you may have to guide this work.

VinylVault commented

2019-04-04 10:40:21 +00:00

(Migrated from github.com)

@joejvggithub @peterpetrov @Llewellynvdm anything i can do to help on this project?

aamigo commented

2019-04-18 09:45:53 +00:00

(Migrated from github.com)

I have just added all the subtitles for JCB tutorials, I have manually updated them so that they are the correct words (exactly what was said), not just machine generated. Llewellyn has said we can update all the videos on youtube with these subtitles. Next I think we will work towards converting them into the Wiki format that @joejvggithub has started.

I have just [added all the subtitles for JCB tutorials](https://github.com/vdm-io/JCB-Tutorials-Subtitles), I have manually updated them so that they are the correct words (exactly what was said), not just machine generated. Llewellyn has said we can update all the videos on youtube with these subtitles. Next I think we will work towards converting them into the Wiki format that @joejvggithub has started.

🎉 2