joomla/Component-Builder
joomla/Component-Builder
39
23
Fork 11
Code Issues 83 Pull Requests Projects 4 Wiki Activity

Updated 046 General overview of how community snippets work (markdown)

Amigo 2019-08-26 15:41:49 +02:00
parent 754a0310e9
commit 0e705c0be3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
046-General-overview-of-how-community-snippets-work.md

@ -20,37 +20,37 @@ Looking at the new Snippets Area, the type of the Snippet may be seen, then the
[00:01:29](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m29s)
Yet there are major changes taken place because we have what is known as local Snippets, and then community Snippets. We have enlarged the Snippets area so that you can contribute to the community Snippets, and also import from those Snippets that is been added to the community by others.
Yet there are major changes taken place because we have what is known as local Snippets, and then community Snippets. We have enlarged the Snippets area so that you can contribute to the community Snippets, and also import from those Snippets that have been added to the community by others.
### Contribute Snippets To The Community - Import Snippets That Is Been Added To The Community By Others
[00:01:56](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h01m56s)
Now how does that exactly work? Well, Snippets that already exist are Snippets that either I made or someone else and they already have what is known as a contributor. The name of the contributor, its email address, web address and so forth. When you create a Snippet [00:02:19](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m19s) we will use your details to create this contribution. If we open an existing Snippet and you go to the contribution area, you'd see that there are names in these Fields. If there aren't any names then that means the update didn't do exactly what it should have done. When you go to the Snippets area [00:02:46](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m46s) where you get Snippets, I'll show you that in a moment, there is a place for you to update all the contributor names. Be sure to have their names in the Database. The reality is these details should be in there already. If they are not, it's not a Snippet you made. You don't need to really worry about it. These details only really apply when you want to share a Snippet or when you want to improve a Snippet and then we will add the correct details in any way. So really it's not to be worried about. Here you'll see 'How Contributed Details Work' [00:03:25](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h03m25s) are dealt with. We are using your company details that are set in the global Options you could click 'Option' button to get there under the company tab of the JCB for the new Snippets you create. You cannot change the Contributed Details of the Snippet that already exists at this time via this area. So that is a simple heads up. This area is really only for the management of the community Snippets. If you're not going to be contributing then this doesn't even matter at all.
Now how does that exactly work? Well, Snippets that already exist are Snippets that either I made or someone else and they already have what is known as a contributor. The name of the contributor, its email address, web address and so forth. When you create a Snippet we will use your details to create this contribution. [00:02:19](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m19s) If we open an existing Snippet and go to the contribution area, you would see that there are names in these Fields. If there are not any names then that means the update did not do exactly what it should have done. When you go to the Snippets area where you get Snippets, there is a place for you to update all the contributor names. [00:02:46](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h02m46s) Make sure to have their names in the Database. These details should be in there already. If they are not, it is not a Snippet you have made, do not worry about it. These details only apply when you want to share a Snippet or when you want to improve a Snippet and then we will add the correct details in any way. Here you'll see 'How Contributed Details Work' are dealt with. [00:03:25](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h03m25s) We are using the company details that are set in the global 'Options'. Click the 'Option' button to get there under the company tab of the JCB for the new Snippets you create. The Contributed Details of the Snippet cannot be changed that already exists via this area. So that is a simple heads up. This area is really only for the management of the community Snippets. If you are not going to be contributing then this does not even matter at all.
### Important - Snippets Mapped The Same Way As Snippets in The Community
[00:03:58](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h03m58s)
What is important though is that your Snippet is mapped the same way as the Snippets in the community. For example if the Name: Grid, Library: UiKit v2 is called Type: Layout then don't change it. Because it will then behave like a new Snippet and not like an existing one. [00:04:17](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m17s) You see because the community uses the Name the Library and the Type to build the Filename. The Filenames we'll look at that also as we go along. All you need to know is there are a bunch of Snippets already in your component. [00:04:38](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m38s) These snippets were shipped with Joomla Component Builder. This is how it was by default.
What is important though is that your Snippet is mapped the same way as the Snippets in the community. For example if the Name: Grid, Library: UiKit v2 is called Type: Layout then do not change it because it will then behave like a new Snippet and not like an existing one. [00:04:17](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m17s) Because the community uses the Name the Library and the Type to build the Filename. All you need to know is there are a bunch of Snippets already in your component. [00:04:38](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m38s) These snippets were shipped with Joomla Component Builder. This is how it was by default.
### Area Called: Get Snippets
[00:04:48](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h04m48s)
We now have an area called Get Snippets. If you are one of those who like to get your name out there and want to become involved in the JCB community and have others know about you and so forth. This is the ideal time to do that if you share a Snippet. Let say if you have created Article Snippet, for example, then you would click on Share Snippets or you could take more than one, it doesn't need to be only one. You can click Share Snippets. This will then create a package. Let me show you. We see that it created a package. It's placed in this Path folder(/media/host/Dropbox/sandbox/joomla/tmp/snippets.zip.
There is an area called 'Get Snippets'. If you would like to get your name out there and want to become involved in the JCB community this is the ideal opportunity to do that through sharing a Snippet. Say, for instance, you have created 'Article Snippet', then you can click on 'Share Snippets' or you may take more than one, it should not necessarily be only one. You can click 'Share Snippets'. This will then create a package. It can be seen that it created a package. It is placed in this Path folder(/media/host/Dropbox/sandbox/joomla/tmp/snippets.zip.)
### Helper Tutorials - Few Links And Shortcuts To Get Involved Sharing Snippets
[00:05:33](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m33s)
You got a few helper tutorials to get you going. If you want to learn this tutorial I'm making now will be this link: https://www.youtube.com, and if you want to learn more about Git, it's this one: https://www.udemy.com/git-quick-start/, and if you want to know how the forking is going to work, then it's this: https://www.youtube.com. If you want to know how to do pull request it, it will be this one: https://www.youtube.com [00:05:55](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m55s) If there are any issues you can open an issue on GitHub: https://github.com/vdm-io/Joomla-Component-Builder-Snippets/issues. This gives you a few links and shortcuts to get involved in sharing Snippets.
There are a few helper tutorials to get you going. If you want to learn this tutorial I am making now will be this link: https://www.youtube.com, and if you want to learn more about Git, it is this one: https://www.udemy.com/git-quick-start/, and if you want to know how the forking is going to work, then it is this: https://www.youtube.com. If you want to know how to do a pull request, it will be this one: https://www.youtube.com [00:05:55](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h05m55s) If there are any issues you can open an issue on GitHub: https://github.com/vdm-io/Joomla-Component-Builder-Snippets/issues. This gives you a few links and shortcuts to get involved in sharing Snippets.<<<
### What Happens When You Share Snippets?
[00:06:07](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m07s)
What happens when you share the Snippet? If someone clicks on Get Snippets, then they will see your name. If that specific Snippet comes up. Let me illustrate that. If we click on Get Snippets it might take a moment depending on how many Snippets are in the repository at this stage. Because it via Ajax it's getting all the Snippets from GitHub and it's building a little page for you. [00:06:38](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m38s) It's just loaded the whole bunch of Snippets. The first view shows you all the current Snippets in the JCB community Snippets Repository. You can go to this repository by simply clicking on this GitHub link. It will take you there.
What happens when the Snippet is shared? If someone clicks on 'Get Snippets', then they will see your name if that specific Snippet comes up. To illustrate that: If we click on Get Snippets it might take a moment depending on how many Snippets are in the repository at this stage because it is getting all the Snippets via Ajax from GitHub and it is building a little page. [00:06:38](https://www.youtube.com/watch?v=qr4I1jeCp7I&list=PLQRGFI8XZ_wtGvPQZWBfDzzlERLQgpMRE&t=00h06m38s) It has just loaded the whole bunch of Snippets. The first view shows all the current Snippets in the JCB community Snippets Repository. Go to this repository by simply clicking on this GitHub link. <<<<<
### Snippets - In Sync