Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move godotengine.org wiki to GitHub #14

Closed
caitp opened this issue Feb 10, 2014 · 11 comments
Closed

Move godotengine.org wiki to GitHub #14

caitp opened this issue Feb 10, 2014 · 11 comments

Comments

@caitp
Copy link

caitp commented Feb 10, 2014

The main reason for doing this is to provide more reliable hosting, and out-of-box support for GFM.

Alternatively, moving this stuff into the source directory itself as Markdown would make it easier to review community documentation updates.

Either way would be an improvement, I'm finding that the godotengine.org wiki is frequently either very slow to respond, or just times out.

@amagnoni
Copy link

Yep... i think it will be great!
A while ago I was thinking about how the community could update the wiki. but I completely forgot that here also has wiki!

@reduz
Copy link
Member

reduz commented Feb 10, 2014

Hi! The main reason I'm using dokuwiki is that a lot of the engine documentation is generated using code from an xml with a script and updated as the engine adds new functions, classes and constants automatically. I'm not sure if this can be done with the Github wiki, or if i can periodically update those pages from an external source.

@caitp
Copy link
Author

caitp commented Feb 10, 2014

I believe the Github wiki can be edited via API endpoints, so integration there should be fairly trivial to implement

@reduz
Copy link
Member

reduz commented Feb 10, 2014

This seems really cool, I guess I'll have to read more on how github stores the wiki content.
If you guys are interested, there is a file in godot, at doc/base/classes.xml . This XML is generated by godot itself using godot -doctool classes.xml , and makes the xml contain all the information on the engine (reads the text descriptions and updates it while adding new functions and classes).

I have a script every night that converts this xml to dokuwiki format and uploads it to godotengine.org, If you can help me out on a way to automatize the same process and send all the class reference to a section of the github wiki, I'll change it asap.

@vinzenz
Copy link
Contributor

vinzenz commented Feb 10, 2014

Actually I think it might be more beneficial to put only the tutorials into the wiki and generate static HTML files for the documentation and put them into the gh-pages branch of this repository. Which then in turn can be accessed via http://okamstudio.github.io/godot

In regards to Pages, see here: https://help.github.com/categories/20/articles

@TiZ-HugLife
Copy link
Contributor

I agree with vinzenz. I don't think it's particularly important for API docs to be on github, but it'd be better for community maintainability if the tutorials were here.

@wardsky
Copy link

wardsky commented Feb 19, 2014

@reduz - could you add the dokuwiki pages to the source tree? Or maybe start a new godot-doc project? Either way, that'd let people contribute to the documentation effort, and it should be easy enough to sync them back to the godotengine.org wiki.

@reduz
Copy link
Member

reduz commented Feb 19, 2014

Sorry, I've been really really busy with work and fixing bugs in Godot,
will see how to deal with the wiki on weekend.

On Wed, Feb 19, 2014 at 8:44 AM, wardsky [email protected] wrote:

@reduz https://github.com/reduz - could you add the dokuwiki pages to
the source tree? Or maybe start a new godot-doc project? Either way, that'd
let people contribute to the documentation effort, and it should be easy
enough to sync them back to the godotengine.org wiki.

Reply to this email directly or view it on GitHubhttps://github.com//issues/14#issuecomment-35490107
.

@wardsky
Copy link

wardsky commented Feb 19, 2014

Great, thanks for your hard work!

@adolson
Copy link
Contributor

adolson commented Dec 9, 2014

official docs are on github. community wiki on azure. close this.

@reduz reduz closed this as completed Dec 9, 2014
CharlesMicou added a commit to CharlesMicou/spatialgodot that referenced this issue Jan 29, 2019
lawnjelly added a commit to lawnjelly/godot that referenced this issue Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants