Project Support => General ElkArte discussions => Topic started by: Mstcool on February 14, 2015, 11:53:04 pm
Title: Basics for Wiki?
Post by: Mstcool on February 14, 2015, 11:53:04 pm
Hey guys,
Just wondering, are you guys going to be making wiki docs on basic things to do (e.g creating a group, creating boards, etc etc)? If yes, I can help if you guys want.
Where and how do I make a doc? I think its on github....I am a github newbie so I'll need someone to tell me the exact steps in order to create a doc and publish it. Ill write things myself and people can improve it and stuff.
Maybe make a wiki doc board where we can discuss things about the wiki and stuff. :P
Nvm, I found out how to create the page and stuff, but I create it on github, right?
Edit: I am not sure if I posted this in the right board or no. :p
Title: Re: Basics for Wiki?
Post by: Joshua Dickerson on February 15, 2015, 08:08:39 am
Yes, create it on github
Title: Re: Basics for Wiki?
Post by: Spuds on February 15, 2015, 10:54:58 am
Any and all items to help on the Wiki would be greatly appreciated !!
@Jorin offered up the excellent work he did as well ( http://www.elkarte.net/community/index.php?topic=2457.msg16265#msg16265 ) this is in German but translator may provide a good starting point.
There was also some discussion in this thread, at least about a basic structure at some point, http://www.elkarte.net/community/index.php?topic=2192.msg14157#msg14157 but right now we need the articles of course.
All of the wiki items are on GitHub as you found: https://github.com/elkarte/Elkarte/wiki As you can see for the most part they are developer centirc things vs user centric although there are a couple hidden in there, like https://github.com/elkarte/Elkarte/wiki/Sphinx-Fulltext-Search and https://github.com/elkarte/Elkarte/wiki/Posting-by-Email-Feature for the less used and understood functions.
Anyway, thanks for any help you can provide :D
Title: Re: Basics for Wiki?
Post by: hugbear on February 15, 2015, 11:30:35 am
Quote from: Mstcool – Just wondering, are you guys going to be making wiki docs on basic things to do (e.g creating a group, creating boards, etc etc)? If yes, I can help if you guys want.
Maybe you could start by creating a doc to help the rest of us, git noobs, get up to speed in contributing to the ElkArte docs? :-[
Title: Re: Basics for Wiki?
Post by: Mstcool on February 15, 2015, 09:03:42 pm
Quote from: Mstcool – Just wondering, are you guys going to be making wiki docs on basic things to do (e.g creating a group, creating boards, etc etc)? If yes, I can help if you guys want.
Maybe you could start by creating a doc to help the rest of us, git noobs, get up to speed in contributing to the ElkArte docs? :-[
Yeah, sure. I'll post make a thread in the next few days explaining how to make docs and contribute to it. :P
Title: Re: Basics for Wiki?
Post by: Spuds on February 15, 2015, 11:06:51 pm
Been playing with a little structure for the Wiki https://github.com/Spuds/Elkarte/wiki Just a start but should begin to help with where to put content as its written.
Title: Re: Basics for Wiki?
Post by: Mstcool on February 15, 2015, 11:20:22 pm
I will (try) to make an installation guide. For now, I will make the page and write a sentence and two, and I will complete it within the next few days. :p
EDIT: Started it, this is what I have so far. https://github.com/Mstcool/Elkarte/wiki/Installation-Guide
Once I finish it and improve it, how do I add it to ElkArt's Wiki? Also, are there any server (or other) requirements I am missing on my installation guide?
Title: Re: Basics for Wiki?
Post by: Mstcool on February 16, 2015, 12:54:02 am
I hope you guys don't mind. I made an installation guide test page on the Elkarte wiki site. Just wanted to see how I would transfer things from my repo onto the Elkarte one. How would I do this?
Title: Re: Basics for Wiki?
Post by: emanuele on February 16, 2015, 05:14:16 am
Did you already put it on the wiki? I still have to understand if the github wiki has a "recently added" page... :-\
Title: Re: Basics for Wiki?
Post by: Mstcool on February 16, 2015, 11:38:51 am
Quote from: emanuele – Did you already put it on the wiki? I still have to understand if the github wiki has a "recently added" page... :-\
I added the test page of installation guide onto the wiki. The actual doc is still on my repo cuz I am not done writing it. :P
Title: Re: Basics for Wiki?
Post by: emanuele on February 16, 2015, 06:27:11 pm
@Spuds I seem to remember PSQL should be 9.something, am I dreaming? :-\
I copied all the requirements from the server requirement doc :p
Title: Re: Basics for Wiki?
Post by: Spuds on February 16, 2015, 08:40:58 pm
I checked the install and upgrade scripts and they have 8.3 ... I think we moved from 8.0 to 8.3 as the min way back. Don't remember on 9.x, its always possible we did, but I can't remember :-[
Title: Re: Basics for Wiki?
Post by: Mstcool on February 16, 2015, 09:02:37 pm
There is no pull request kinda thing for the wiki, right? So I would have to copy things from my repo and add it to Elkarte's, right?
Title: Re: Basics for Wiki?
Post by: Mstcool on February 16, 2015, 11:12:08 pm
I also started working on a documentation on creating a member group
Title: Re: Basics for Wiki?
Post by: emanuele on February 17, 2015, 05:38:25 am
Quote from: Spuds – I checked the install and upgrade scripts and they have 8.3 ... I think we moved from 8.0 to 8.3 as the min way back. Don't remember on 9.x, its always possible we did, but I can't remember :-[
hmm... okay, I guess I was really dreaming! LOL
Title: Re: Basics for Wiki?
Post by: Mstcool on February 18, 2015, 12:58:53 am
Hey, maybe add a wiki board where we can discuss things about the wiki :p
Also, I have question(s) that I don't feel the need to make a topic for:
When adding a member group, you know how there are group types? What is the private group used for? Like what would I put as the definition
Same thing goes for Post based. I know what they do, I just don't understand how to explain them. :P
Check it out at: https://github.com/Mstcool/Elkarte/wiki/Creating-Member-Groups-(Mstcool's-Work)
Y'all may edit it my doc, if you guys want. :)
EDIT: Also, the installation guide is pretty much done. What do I need to finalize? Also, is there a page for downloads or something? Check it out at: https://github.com/Mstcool/Elkarte/wiki/Installation-Guide-(Mstcool's-Work)
Just so y'all know, I will remove the "(Mstcool's Work)" part, the reason I have it in my repo is cuz it makes it easier for me to know what docs I am editing :P
In the Official Wiki, I will remove it. :P
EDIT #2: I know my wording is bad, but it gets the point across (hopefully), for the time being. I will improve on it time to time. Also, people can also help on improving it later on. :)
Title: Re: Basics for Wiki?
Post by: Jorin on February 18, 2015, 01:56:12 am
Quote from: Mstcool – EDIT: Also, the installation guide is pretty much done. What do I need to finalize?
Screenshots! People love screenshots and they explain some things better then words only.
Title: Re: Basics for Wiki?
Post by: emanuele on February 18, 2015, 04:13:10 am
Quote from: Mstcool – Hey, maybe add a wiki board where we can discuss things about the wiki :p
It may be an idea.
Quote from: Mstcool – Also, I have question(s) that I don't feel the need to make a topic for:
And you want an entire board? :P
Quote from: Mstcool – When adding a member group, you know how there are group types? What is the private group used for? Like what would I put as the definition
hmm... A couple of random thoughts: is the "normal" type of groups (in the sense that most of the groups are private), only people with the right privileges (assign member group, or a group moderator) can add/remove it from another member. I don't remember any other characteristic that make it different from other types of groups, but I may just have a bad memory. :P
Quote from: Mstcool – Same thing goes for Post based. I know what they do, I just don't understand how to explain them. :P
ehhh... good question, I guess something like: group automatically assigned based on the number of posts a member has.
Quote from: Mstcool – Check it out at: https://github.com/Mstcool/Elkarte/wiki/Creating-Member-Groups-(Mstcool's-Work)
:+1:
Quote from: Mstcool – EDIT: Also, the installation guide is pretty much done. What do I need to finalize? Also, is there a page for downloads or something? Check it out at: https://github.com/Mstcool/Elkarte/wiki/Installation-Guide-(Mstcool's-Work)
There is: the download button on the home page http://www.elkarte.net/ that always points to the latest version, there is the releases page https://github.com/elkarte/Elkarte/releases that has all the releases with full package and update packages.
Quote from: Mstcool – EDIT #2: I know my wording is bad, but it gets the point across (hopefully), for the time being. I will improve on it time to time. Also, people can also help on improving it later on. :)
:+1:
Title: Re: Basics for Wiki?
Post by: Spuds on February 18, 2015, 05:36:45 pm
As threatened, and now done, I pushed a re-layout of the wiki.
@Mstcool I included the two pages you did in that update, in the future you can just edit the page "stubs" that are there or add new ones (like you did)
I broke things down in to 4 main areas, each "section" has its own sidebar that can be edited as well. Behind the scenes (if you do a full pull of the wiki repo to your local) you will see directories for each section.
The wiki does not care about directories at all in terms of linking to a page, so [[bla]] will be found no matter where it is, that structure is just to help the sidebars
At the top of the pages I tried to add a basic breadcrumb tree, seems that has to be done manually so there will be some cut/paste errors in that :P
The Admin section reflects the current menu structure of the ACP, so there should be a page stub for each area that can be edited. The User section is pretty blank, thats where I hope we can use some of @Jorin work. The Dev area is whatever stuff we have randomly added to date.
Don't like it, use revert it rebase it and toss it out :P
Title: Re: Basics for Wiki?
Post by: Mstcool on February 18, 2015, 06:05:34 pm
Quote from: Spuds – As threatened, and now done, I pushed a re-layout of the wiki.
@Mstcool I included the two pages you did in that update, in the future you can just edit the page "stubs" that are there or add new ones (like you did)
I broke things down in to 4 main areas, each "section" has its own sidebar that can be edited as well. Behind the scenes (if you do a full pull of the wiki repo to your local) you will see directories for each section.
The wiki does not care about directories at all in terms of linking to a page, so [[bla]] will be found no matter where it is, that structure is just to help the sidebars
At the top of the pages I tried to add a basic breadcrumb tree, seems that has to be done manually so there will be some cut/paste errors in that :P
The Admin section reflects the current menu structure of the ACP, so there should be a page stub for each area that can be edited. The User section is pretty blank, thats where I hope we can use some of @Jorin work. The Dev area is whatever stuff we have randomly added to date.
Don't like it, use revert it rebase it and toss it out :P
Alright, thank you. :)
What are Stubs?
Edit: Nvm, I get it lool. :p
Title: Re: Basics for Wiki?
Post by: Mstcool on February 18, 2015, 06:08:44 pm
Btw, this doesn't show up
http://prntscr.com/66wmuk
Title: Re: Basics for Wiki?
Post by: Spuds on February 18, 2015, 06:26:08 pm
Thanks, should be fixed now .. Ooops , your edits should be back as well !
Title: Re: Basics for Wiki?
Post by: emanuele on February 18, 2015, 06:35:19 pm
Cool re-org!! :D
Title: Re: Basics for Wiki?
Post by: emanuele on March 18, 2015, 05:18:48 am
I added a redirect board as child of Support to the Admin / Setup doc page. Does it make it more evident? Is there a better place for it?
Title: Re: Basics for Wiki?
Post by: Mstcool on March 19, 2015, 03:24:57 am