Title: Re: Items Needed To Be Added Into The Wiki
Post by: Spuds on February 17, 2015, 01:01:49 pm
I think adding "stub" pages in the wiki in the structure that we think works is a good thing to do. It will help people see what areas need to be edited without fearing that they are going to add a page in the wrong area or something.
I have a bit more work to do on the small revamp of the wiki layout that I'll get in place today or tomorrow, all that's left is to have the sidebar reflect the pages for the area that you are in, right now its all pages so its pretty much useless.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 17, 2015, 05:10:54 pm
What's a stub page?
Why don't yall use an actual wiki software? Github wiki is kind of useless for a forum wiki, in my opinion :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Allan on February 17, 2015, 07:21:34 pm
Why don't yall use an actual wiki software? Github wiki is kind of useless for a forum wiki, in my opinion :P
I am with you you I personally find Github confusing.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Jorin on February 18, 2015, 01:00:52 am
Ever thought about creating a knowledge base as part of the board?
At SMFPortal we had mediawiki but it caused too many problems. We made forms for people to use so the articles had the same structure for example. But this leaded to problems with updates.
We decided to migrate the articles into our board then. So no one needs to register at the wiki again and all know how to use the board editor (while the writing of mediawiki code is quite different).
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Eliana Tamerin on February 18, 2015, 01:35:30 am
Quote from: Jorin – Ever thought about creating a knowledge base as part of the board?
At SMFPortal we had mediawiki but it caused too many problems. We made forms for people to use so the articles had the same structure for example. But this leaded to problems with updates.
We decided to migrate the articles into our board then. So no one needs to register at the wiki again and all know how to use the board editor (while the writing of mediawiki code is quite different).
True, but a wiki is superior for documentation given its ability to track revisions. Whenever you have a written explanation of technical procedures, it's going to require revision (especially as new features are added). Being able to see who added what, or who removed what, or who edited what is a real boon.
Basically, things change. Knowledge changes. You want the most up-to-date explanation of things and knowledge displayed to users. But you don't want to lose the old things or knowledge.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Jorin on February 18, 2015, 01:54:13 am
You're right about this point. Just wanted to add my idea. Truth is, we had a small team at SMFPortal then and only two or three of us worked with the wiki. So we had no problem with that.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 18, 2015, 06:14:14 pm
Installation Guide is pretty much done. If anyone can, please improve the wording and add/remove things. :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: emanuele on February 19, 2015, 04:45:01 am
Dunno... I used to be part of the doc team while the transition to mediawiki, and even though MW is without any doubt The Wiki software, it's also a pain in terms of maintenance and set up (intended as time spent to get the basics needs "in place").
Dunno... I used to be part of the doc team while the transition to mediawiki, and even though MW is without any doubt The Wiki software, it's also a pain in terms of maintenance and set up (intended as time spent to get the basics needs "in place").
It's different for sure, and it looks a bit limited at first sight. What do you feel is lacking at the moment?
Tbh, when I go on github and go to the Ea repo, and I see the wiki page, to me, it seems like it's either some default wiki on how to navigate through github and/or a wiki on how to contribute to the repo. :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: emanuele on February 19, 2015, 07:53:05 am
Well... could be because the only pages ever written up to now are only about how to contribute? :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 19, 2015, 10:26:54 pm
I have also created a wiki page with this same information. This way, we can all know what pages are done and what pages are being written and by who.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 21, 2015, 07:32:50 pm
I reorganized the to do list page, however, because of the sidebar, the whole chart doesn't show up.
@Spuds , is there any way I can remove the sidebar just in the to do list page?
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 22, 2015, 02:01:38 am
Quote from: Mstcool – I reorganized the to do list page, however, because of the sidebar, the whole chart doesn't show up.
@Spuds , is there any way I can remove the sidebar just in the to do list page?
Nvm, I changed it. However, I still would like to know if there is anyway to remove the sidebar in just one page :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Spuds on February 22, 2015, 08:38:25 am
The sidebar is a bit of a conundrum on the GitHub Wiki ... Here is what I know. You can have a _Sidebar file in a directory and GitHub will use that file to show the sidebar when you have navigated to that area. So to have a custom sidebar for a page or group of pages, those page(s) must be in its their own directory with its own _Sidebar file. If a child directroy does not have a _Sidebar file then it will use the parent on instead.
In order to work with directories you need to fork the wiki "repo" to you local machine. If you do this you will see that there are currently several directories, right now one for each area of the "main" page sidebar.
So for example when you go to the setup-guides area, in the directory there is a _Sidebar file, that's why the sidebar changes in that area https://github.com/elkarte/Elkarte/wiki/Setup-Home That _Sidebar file is just another wiki page really. Setup-Home lives in the setup-guides directory, so when wiki loads that page it also loads the _Sidebar from that directory.
Now the problem with the online git editor, or the wiki in general, is that it does not really know about directories. When you create a page you don't link to it by directory, just name, as far as the wiki is concerned there are no directories to reference, it simple finds the first matched name and loads it. So you have to be careful not to use duplicate wiki page names other than _Sidebar.
For example if you were to select the edit icon for the sidebar in the above link, it will actually pull up the _Sidebar file from the root directory since that's the first one it finds since it does not use directories. The only way to edit that file is to get a local copy so you can directly edit the file.
If you want a todo sidebar, we need to move the todo page(s) to their own directory and in that directory create the _Sidebar That will give a custom one, but you can't remove it (that I know) so unfortunately they tend to collide with tables or content that does not flow.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 22, 2015, 02:30:17 pm
Quote from: Spuds – The sidebar is a bit of a conundrum on the GitHub Wiki ... Here is what I know. You can have a _Sidebar file in a directory and GitHub will use that file to show the sidebar when you have navigated to that area. So to have a custom sidebar for a page or group of pages, those page(s) must be in its their own directory with its own _Sidebar file. If a child directroy does not have a _Sidebar file then it will use the parent on instead.
In order to work with directories you need to fork the wiki "repo" to you local machine. If you do this you will see that there are currently several directories, right now one for each area of the "main" page sidebar.
So for example when you go to the setup-guides area, in the directory there is a _Sidebar file, that's why the sidebar changes in that area https://github.com/elkarte/Elkarte/wiki/Setup-Home That _Sidebar file is just another wiki page really. Setup-Home lives in the setup-guides directory, so when wiki loads that page it also loads the _Sidebar from that directory.
Now the problem with the online git editor, or the wiki in general, is that it does not really know about directories. When you create a page you don't link to it by directory, just name, as far as the wiki is concerned there are no directories to reference, it simple finds the first matched name and loads it. So you have to be careful not to use duplicate wiki page names other than _Sidebar.
For example if you were to select the edit icon for the sidebar in the above link, it will actually pull up the _Sidebar file from the root directory since that's the first one it finds since it does not use directories. The only way to edit that file is to get a local copy so you can directly edit the file.
If you want a todo sidebar, we need to move the todo page(s) to their own directory and in that directory create the _Sidebar That will give a custom one, but you can't remove it (that I know) so unfortunately they tend to collide with tables or content that does not flow.
Oh, I understand. That's fine :)
How come you guys don't use like an actual wiki software tho? :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Spuds on February 22, 2015, 04:34:44 pm
Because this one requires no server resources, no money, no admin maintenance, no software updates, etc its all managed for us .... its not perfect by any means but given the free resources and time of the members its a good compromise at this time IMO
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 22, 2015, 06:00:31 pm
Quote from: Spuds – Because this one requires no server resources, no money, no admin maintenance, no software updates, etc its all managed for us .... its not perfect by any means but given the free resources and time of the members its a good compromise at this time IMO
Oh, trueeeee
Title: Re: Items Needed To Be Added Into The Wiki
Post by: emanuele on February 22, 2015, 06:14:01 pm
In other words... we are LAZY!!!!
/me runs. :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 22, 2015, 09:24:07 pm
What is the difference between update and upgrade?
EDIT: Also, is everything I have added in this doc correct?
Usually "update" is considered a 1.0.1 to 1.0.2 to 1.0.3 (micro versions), while "upgrade" is when you go from 1.0.x to 1.1 or 2.0, etc. (minor/major version upgrades).
Usually "update" is considered a 1.0.1 to 1.0.2 to 1.0.3 (micro versions), while "upgrade" is when you go from 1.0.x to 1.1 or 2.0, etc. (minor/major version upgrades).
point to: https://github.com/elkarte/Elkarte/releases
suggest to pick the most recent version released
and pick one of the files "ElkArte_vX-Y-Z_install.zip", "ElkArte_vX-Y-Z_upgrade.zip" (at the moment there isn't any), "ElkArte_vX-Y-Z_patch.zip"
use it accordingly.
Alright, thanks :)
I'll update it... Probably by tmrw
Title: Re: Items Needed To Be Added Into The Wiki
Post by: emanuele on February 25, 2015, 04:06:15 am
I was thinking: instead of speaking of "update" and "upgrade", wouldn't be better to use "patch" and "upgrade"? The first pair of terms is rather similar and may be confused, but the second should be much easier to distinguish and explain.
What do you think?
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Jorin on February 25, 2015, 04:18:53 am
Good idea!
Title: Re: Items Needed To Be Added Into The Wiki
Post by: radu81 on February 25, 2015, 10:16:49 am
or "patch" and "migrate" or "update" and "migrate"
migrate is used on joomla
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 25, 2015, 05:39:42 pm
Quote from: Mstcool – Migrate would mean coming from a different software to this software
That's a conversion. Anyway it has no difference for me
It is conversion but some people also say migrate. Plus, migrate doesn't really make sense to use instead of upgrade because you are upgrading a software rather than migrating it. :P
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Jorin on February 26, 2015, 01:04:39 am
Nobody uses conversion for the change of a software here in germany. Migration is the term always used. I am for "patch" and "migration".
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 26, 2015, 01:08:48 am
Quote from: Jorin – Nobody uses conversion for the change of a software here in germany. Migration is the term always used. I am for "patch" and "migration".
But the doc isn't on conversion. It's on upgrading and updating it :P
Patch can work, let's just keep upgrade the same as it is. What do yall think?
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Jorin on February 26, 2015, 01:46:05 am
Sorry, missunderstanding. O:-)
Patch = 1.0.2 to 1.0.3 Upgrade = 1.0.2 to 1.1.0 or to 2.0.0 Migration = Software XYZ to ElkArte
Title: Re: Items Needed To Be Added Into The Wiki
Post by: emanuele on February 26, 2015, 06:15:37 am
Random thoughts (I already burned my brain with the other post lol).
I tend to use "conversion" for the move from one software to another.
Interesting the "migration" term, I don't know much about joomla. Reading the https://docs.joomla.org/Why_Migrate page and https://docs.joomla.org/Portal:Upgrading_Versions , the term seems to be used for major "upgrades" (i.e. 1.x to 2.0), and in that sense it is not a bad idea. Actually, at some point, it may be useful to have this distinction[1], but on the other hand it may make things more confused... :-\ Spoiler (click to show/hide)
And now you are giving me the terrible idea that the major upgrades may be dealt with OpenImporter, making them really a sort of "conversion"...no, I shall not think about that, it's too early!! xD
To think.
1 Because the two operations are technically quite different: during a 1.0 to 1.1 "upgrade" the theory is that everything (addons and themes) should still be compatible, while during an 1.x to 2.0 few things may break (badly).↵
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Spuds on February 26, 2015, 01:31:07 pm
Quote from: Mstcool – I guess patch and upgrade would work, but Spuds will have to change the names on the sidebar, I don't have access to it :P
You should be able to do that, but yes it does require getting a full local copy of the wiki/repo and I understand that level of Gitiness is not for everyone. Whatever you decide on for the name, just open an bug/issue on github so the request does not get lost and I'll get it taken care of!
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 26, 2015, 09:30:22 pm
I tend to use "conversion" for the move from one software to another.
Interesting the "migration" term, I don't know much about joomla. Reading the https://docs.joomla.org/Why_Migrate page and https://docs.joomla.org/Portal:Upgrading_Versions , the term seems to be used for major "upgrades" (i.e. 1.x to 2.0), and in that sense it is not a bad idea. Actually, at some point, it may be useful to have this distinction[1], but on the other hand it may make things more confused... :-\ Spoiler (click to show/hide)
And now you are giving me the terrible idea that the major upgrades may be dealt with OpenImporter, making them really a sort of "conversion"...no, I shall not think about that, it's too early!! xD
To think.
Well, migration can work but for example, you get a house, in a way, migration is when you would move from one house to another (aka known as moving), in this case it would be softwares. Also, upgrade would mean, adding stuff to your house but keeping location, base and everything the same (aka known as renovation), but in this case, upgrade
We can use migrate, but it will confuse people, I believe. :P
And okie, thank you @spuds :)
1 Because the two operations are technically quite different: during a 1.0 to 1.1 "upgrade" the theory is that everything (addons and themes) should still be compatible, while during an 1.x to 2.0 few things may break (badly).↵
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Allan on February 27, 2015, 06:42:56 am
Getting off the topic I was looking for how to install ElkArte and wasn't able to find any docs on how to.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 28, 2015, 05:41:33 pm
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Allan on February 28, 2015, 05:46:35 pm
Thank you, I now ELkArte is different than SMF but we don't need any file permission changes. Please I you might want to add that magic_quotes need to be set to off for the installation to run.
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on February 28, 2015, 06:02:12 pm
Quote from: Allan – Thank you, I now ELkArte is different than SMF but we don't need any file permission changes. Please I you might want to add that magic_quotes need to be set to off for the installation to run.
Done. :)
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Allan on February 28, 2015, 07:20:15 pm
Quote from: Allan – Thank you, I now ELkArte is different than SMF but we don't need any file permission changes. Please I you might want to add that magic_quotes need to be set to off for the installation to run.
Done. :)
Awesome I just know it gets me every time. ;)
Title: Re: Items Needed To Be Added Into The Wiki
Post by: Mstcool on March 01, 2015, 03:55:54 am