Changes to our style process (Important)

classic Classic list List threaded Threaded
22 messages Options
12
Reply | Threaded
Open this post in threaded view
|

Re: Changes to our style process (Important)

Daniel Sobey
Using git as a wiki replacement can be a good idea and can be easy to do if you know how.
Github encourages you to use a text document using markdown.
Markdown is a wiki like language and can be easily converted into html.

Editing a markdown in github is just as easy as editing a wiki page.
First create an account and login to github.
Go to the project page and find the file you want to edit.
click the edit button
make your change, there is a preview tab to see what the result will be.
enter a comment on what you have changed.

The change will be made to your local branch and a "pull request" will be made to the owner notifying them of the change.
The owner will then be able to review and merge the changes into the officia document.

For a good example of this working well see the following project:
This is just a list of programming resources but has had 2630 changes by 478 people.



On Sat, Nov 1, 2014 at 5:13 AM, caller#6 <[hidden email]> wrote:
On 10/30/2014 05:58 PM, Ben Ockmore wrote:

> I do still think that putting it all on Git is a good idea though
> (especially given the online editing capabilities of GH and BB). Just
> not TT templates, and separate from the server code.
>

For anybody interested, keep an eye on
https://github.com/PharkMillups/beautiful-docs , an ever-growing roundup
of doc-related resources.


_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style


_______________________________________________
MusicBrainz-style mailing list
[hidden email]
http://lists.musicbrainz.org/mailman/listinfo/musicbrainz-style
Reply | Threaded
Open this post in threaded view
|

Re: Changes to our style process (Important)

jesus2099
+1 docs in git with Markdown
 PATATE12   jesus2099   GOLD MASTER KING   FAKE E-MAIL ADDRESS 
12