Opening the guide to contributions

Post comments, typo reports and suggestions regarding the Factorio guide (http://guide.factorio.com).

Opening the guide to contributions

Postby Klonan » Sun Sep 04, 2016 12:07 pm

The guide repository is now public, so anyone can submit pull requests for fixes and additions:
https://github.com/wube/factorio-guide

Please make sure to read the readme:
https://github.com/wube/factorio-guide/ ... readme.txt
Code: Select all
Hello,

This is the factorio guide readme, it is a very simple document with some information and terms about this repository.

The Guide is open to the public for viewing, forking and submitting pull requests.

We hope to have collaborators to help us make the guide as great as possible, but we want to remain in control of the content.
So if you would like to submit changes, it will be reviewed before either being merged or discarded.

Before you start we want to make some things clear,
We are still the owners of the guide and the contents of the repository,
Any changes or pull requests you submit will belong to us, and we may or may not include them in the guide,
And may or may not edit them in any way.

If you want to make sure you won't be wasting your time with work, email us at support[at]factorio.com before starting,
We can give advice, and make sure that we can work together to make the guide as great as possible.

I hope this is clear, if you have any questions feel free to email in.

Klonan


If you have any questions suggestions or inquiries please post them here or PM me
User avatar
Klonan
Factorio Staff
Factorio Staff
 
Posts: 2082
Joined: Sun Jan 11, 2015 2:09 pm

Re: Opening the guide to contributions

Postby Zeblote » Sun Sep 04, 2016 12:55 pm

Can someone make it so the huge header is not static on the page?
Zeblote
Filter Inserter
Filter Inserter
 
Posts: 832
Joined: Fri Oct 31, 2014 11:55 am

Re: Opening the guide to contributions

Postby Klonan » Sun Sep 04, 2016 1:23 pm

Zeblote wrote:Can someone make it so the huge header is not static on the page?


Yes i will do that this week, i fixed it for the 0.13 page but not the general guide
User avatar
Klonan
Factorio Staff
Factorio Staff
 
Posts: 2082
Joined: Sun Jan 11, 2015 2:09 pm

Re: Opening the guide to contributions

Postby aubergine18 » Mon Sep 05, 2016 12:07 am

Would there be any benefit in converting the guide source to be markdown and then having a release process that converts the markdown to html (a good example of that can be see in the eslint project)? It would also make the guide much easier to view and even edit (for casual contributors) on github.
Better forum search for modders: Enclose your search term in quotes, eg. "font_color" or "custom-input" - it prevents the forum search from splitting on hypens and underscores, resulting in much more accurate results.
User avatar
aubergine18
Smart Inserter
Smart Inserter
 
Posts: 1266
Joined: Fri Jul 22, 2016 8:51 pm

Re: Opening the guide to contributions

Postby ssilk » Wed Sep 14, 2016 11:15 am

Markdown is just a small subset of html... and you need to update it every time, the docs change.

Oh there are some converters:
https://github.com/baynezy/Html2Markdown
https://www.npmjs.com/package/html2markdown
http://blog.ilvelh.com/html2markdown/index.html

I would say: just do it and see if your pull request will be accepted. :)
Cool suggestion: Eatable MOUSE-pointers.
Have you used the Advanced Search today?
Need help, question? FAQ - Wiki - Forum help
I still like small signatures...
User avatar
ssilk
Global Moderator
Global Moderator
 
Posts: 9795
Joined: Tue Apr 16, 2013 10:35 pm
Location: Würzburg, Germany


Return to Factorio guide

Who is online

Users browsing this forum: No registered users and 1 guest