Hello -
I'm having a hard time finding documentation on things here, and instead of taking notes when I find it, I'd rather add it to your documentation for end users. I installed the GitHub Desktop, then cloned the wiki, but since I've never done anything with GitHub before, I'm lost already.
I can see Elkarte.wiki in the left column of the GitHub window, with "Open in Explorer" which lets me open a file in TexPad, or Open in "Git Shell", which opens a shell window. (yikes!)
Is there a way to see the existing pages and stubs in the GitHub Desktop window, or could you direct me to instructions on how to edit this?
Thank you.
Random thought: Would editing on the web interface be easier? https://github.com/elkarte/Elkarte/wikihttps://github.com/elkarte/Elkarte/wiki (Account on GitHub needed)
I'm not even sure if you can push to the wiki (never considered the option), the web interface is the was I do it. :)
@billwill thank you very much! This is very, very needed! :D
I'll try the web interface and see if it is easier to understand. Thanks for the screenshot, live627.
Hope my efforts are fruitful.
You can, it's https://github.com/elkarte/Elkarte.wiki.git after all. ;)
Hello -
I've been experimenting with the online gh, and have a couple of questions:
1. Are screenshots an option? They make documentation much easier for the user to understand, and the documenter to make.
2. If I want to create a new structure in an area, is there a "sandbox" area I can experiment with? I think for the user, it would be more accessible if features were listed according to what people want to accomplish rather than listing features and configurations and then they have to figure out which category of features what they want is in. For example instead of having permissions scattered among boards, groups, members, etc., there would be a category for permissions, and explain them all there, since they are so intertwined.
3. When I edit something, does it just go out, or do you guys have a chance to make sure I'm accurate before the public can view it?
I misspoke in my first post. I was assuming that the admins were the end users. I want to work on admin instead of end users at this point.
1. Yes, but I'm not sure if it can be sensibly done without Git, which a minor bummer I suppose. On the flipside, maybe larger images shouldn't be part of a Git repository in the first place and then it doesn't matter. Also I'm not sure if you and I (i.e., people without write access on the Elk repo) can push there. Still, a lot can be achieved using the GitHub online wiki alone.
3. Not in the regular PR sense I don't think.
1. http://mikehadlow.blogspot.it/2014/03/how-to-add-images-to-github-wiki.html Yep, only from the cloned repo... :-\
2. Not "really", but considering a sandbox, can simply be a namespace, we can decide anything under "sandbox" (i.e. https://github.com/elkarte/Elkarte/wiki/sandbox/Setup-Home ) is sandbox. Otherwise we can create a repo just for the sandbox of the wiki...
3. Out immediately AFAIK. But that's okay, if you want to give an extra, just post here somewhere and someone can have a look. ;)
Thanks for the info. If I can add screenshots, I'll keep them as small as they can be viewed to avoid Frenzie's comment. Don't mistake my slowness in getting started for a lack of interest. My site is in shambles after I changed hosts, and most of the parts of it are not liking php 7, so I'm juggling a bit. I'll focus on getting the screenshots to work on GIT Hub and see how that goes.
I appreciate your effort ;) Elkarte needs a documentation
Thanks! :D
How much is one documentation? :P