GameMonetize Posted August 10, 2015 Share Posted August 10, 2015 Hey all, this topic is to help you contribute to the documentation. This is where all newcomers will go and it has to be great (as far as possible ) Contributing - The easy way To update an existing page, just head to https://github.com/BabylonJS/Documentation/tree/master/contentThis folder is the root of all static content used by the site itself. Then pick a page you want to update and select the edit button: You can then use the great in-browser editor to do your update. When done, just select "Create a new branch for this commit and start a pull request" and hit Propose file change. This will alert the admins who will be able to review or comment your changes Going further You can also go further by cloning the repo in order to work on your own copy before sending all changes that you did to the main repo.To do so, you first have to fork it: You will then see a new repo (a fork) on your own space. Please note the clone url just there: Then you have to clone the fork on your disk. I'm using the great TortoiseGit to work with Git but you can use any compatible tool obviously:- Install GIT: http://www.git-scm.com/downloads- Install TortoiseGIT: https://code.google.com/p/tortoisegit/wiki/Download- Install Node.js (the documentation site runs on node.js): https://nodejs.org/download/ Once everything installed, pick an empty folder, right-click on it and select "Git clone": Use the saved clone url you just grabbed before and hit OK: Your setup is now done. Congratulations Please now open a Node.js command prompt: You will have there exactly the same folder structure as the original repository.To get all the tools used by the site, just execute the following command line: "npm install" (just do it once) You can then start the server with "grunt serve". This will launch a local server and a bunch of tools that will "compile" the changes you'll do. To change any file just head to /content and make your changes on .md files (I'm using Visual Studio Code which is a great editor that works on Mac/Unix and Windows). You changes will be automatically done and visible on http://localhost:3000 Adding new content Now that everything is working well, you may want to add new content. To do so, please open /data/statics.json: This file is a catalog where you can reference new files added to the repo. Sending pull request Once you're done and ready to send a pull request, just right-click again in your "documentation" folder and do the following:- Git Commit->master: - TortoiseGit/Push (still on the right-click menu): - Create a pull request: Now you did your job It is then up to me (or any admins) to validate it If you have any issue, please use this topic to ask your questions. peraxel7, JohnK, Dad72 and 8 others 10 1 Quote Link to comment Share on other sites More sharing options...
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.