Setup an information page on writing posts for Authors

[Amorpheuz]

Is your feature request related to a problem? Please describe. As we move to Jekyll, the way you write blogs changes greatly! Jekyll can take benefit of not only markdown and front matter but also liquid that adds a great amount of functionality to the blog posts.

A detailed guide on how to perform every step would greatly help all the authors.

Describe the solution you'd like

• Explain the usage of front matter.
• Add steps for everything supported on markdown and it's usage.
• Add useful liquid tags and how authors can take benefit from those.
• Suggestions for editors which can be used to easily write markdown/Jekyll content.

Additional context

How the help link will be made available to all is up for discussion. It would be great to have either a separate docs site for the same along with contribution info OR maybe a GUI for the authors to generate post out of.

Info regarding options supported by Jekyll can be found in this handy Cheat Sheet.

[cseas]

I've already added brief instructions on how to add posts in #12 but I agree that might not be beginner-friendly for people who haven't worked with Markdown or static blogs before.

There are three ways we can add detailed instructions:

1. Add them as a separate markdown file, similar to contributing.md
2. Add an example post with all different kinds of elements available for editing. Example
3. Setup a detailed guide using MkDocs.

[Amorpheuz]

I like the sound of going with a Page (rather than a Post) that lists all the different examples & elements. We can keep MkDocs or a similar service for when our blog becomes more feature-rich with its custom functionality.

[cseas]

So how should we add the information for now? We can also host the documentation on readthedocs but that would probably be overkill for little information.

We can use MkDocs to have a section as mozillaindia.org/docs which can be a separate repository or use MkDocs to create a section under blog as mozillaindia.org/blog/docs (I'm not sure how to do this).

[Amorpheuz]

I believe that a simple page called editor-tips or posts-info, etc. with all the info like example 2 of the 3 you listed should be solid enough for now.

[asdofindia]

Please don't replicate documentation. (Keep in mind the cost of keeping that up-to-date as well). Links to official documentation should be enough for most use cases. Let us only focus on writing documentation for things we are building.

[cseas]

The Jekyll Docs explain well how to add a post, although it doesn't go deep into Markdown. Perhaps we should add the author information page once we've setup a single data file to contain information of authors like this?

[Amorpheuz]

Those are the parts like the one about adding authors by @cseas are the ones I was hoping to clarify clearly in the Help page, Rather than documentation; I was aiming for more of a list of examples and tricks that markdown needs to be able to smoothly work with.

The main idea behind this page was making transitions for authors from the nice WYSIWYG editor of WordPress to markdown files much smoother.

[karx]

We can schedule a webinar or share some sort of recording of us posting a new blog entry to MozillaIndia once we get these initials PRs completed.

There was a small segment of JekyllConf 2019 here on Youtube that could be helpful for those new to it. Not the best introduction imo, but might be useful to us as of now. He basically at the linked time, would create a Jekyll blog using only GitHub GUI and also create entries using the Editor in GitHub.

PS: During JekyllConf 2019 a ton of great content about Jekyll and live-streamed and available for those interested.