Document website contributing workflow

[odysseywestra]

I'll like to create a wiki for people who wish to contribute,and maintain the website. Plus it give an opportunity if someone were to write an article about MyPaint to also submit a post to for our so we can link to them. Or to be able to submit fixes for browser compatibility. Other ideas would be:

• Getting Started with Hugo
  • How to submit a post
  • Markdown Coding Style
  • Guide here
• Submit Artwork to be featured in our Gallery Page.
  • Irrelevant, use community forums
• Submit an bug or fix
  • Addressed here

This just some of the ideas I have to help people get started if they want to contribute. What would you guys want in this wiki? I probably want to add a page about our discourse server as well to for those interested in help with admin work. Let me know your guys thoughts below.

[achadwick]

I think this is a great idea. I've been building up https://github.com/mypaint/mypaint/wiki/Contributing recently, and the website is very briefly mentioned in passing on https://github.com/mypaint/mypaint/wiki/Writing-Documentation (recursion, yay! 😀)

We can create a wiki for this project too, and crosslink as needed. Details go on the website wiki, encouragements to get involved can slot in amongst the other pages under the mypaint wiki's Contributing page, and link through to the website wiki for the real deal.

Writing up the conventions we come up with for the website's code and its management would be really helpful.

[odysseywestra]

Just putting this link down for my own reference. Apparently there are different styles to markdown. The one used with this current theme uses Kramdown markdown which is a lot better than github flavored markdown. Need to link that in the wiki when I get around to writing it.

Plus I might also put as part of our coding style to use reference links instead of inline. I makes managing link much easier.

[odysseywestra]

Taking a note about reference links for the wiki to be added later.

I would like the reference links to use a [topic.target] syntax.

## Topic Header

This is a [link related to the topic][topic.target]

#bottom of document
[topic.target]: http://url/to/target

Also the order of the links need to be in the same order they are referenced in the page, unless they are already referenced.

#topic

This is [link 1][topic.target1]
This is [link 2][topic.target2]
This is [link 3][topic.target3]
This use the same link as [link1][topic.target1]

#bottom of document
[topic.target1]: http://url/to/target
[topic.target2]: http://url/to/target
[topic.target3]: http://url/to/target

[odysseywestra]

I like how @Deevad pulled off his wiki for Pepper & Carrot where the wiki on his website is synced with the wiki on Github. That our users can read our documentation on our website instead of having to navigate to our Github Repository to read documentation on it.

[Deevad]

Hi @odysseywestra ; thank you :) I made this system this way: http://www.peppercarrot.com/en/article333/website-update-wiki
I'm sure it could be more automatic ( eg. server doing a cron task to 'git pull' the repo periodically ) but the base: a simple PHP using a markdown library to do a Markdown to HTML. I hope it can help.

[edit: limitation: single language]