[Title]: Example Article Submission

thombruce commented 3 years ago

Title

Example Article Submission

Author Name

Thom Bruce

Article Body

Despite specifying the **markdown** `render` option in the yml template, no WYSIWYG or similar, nor preview or other indication that this is a Markdown field have been shown.

Only my own description that submitters should, _"Please provide your article in Markdown format."_, gives any indication that this field should be Markdown.

My YAML looks just like the example [here](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#yaml-issue-form-template) apart from the omission of a default `value` for the textarea, but this would be disruptive and, I expect, irrelevant to this issue.

In any case, I have written Markdown in this submission as an example, including:

- **bold**
- `inline code`
- _italic_
- [link](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#yaml-issue-form-template)
- ...and this list

This should give me plenty of indication as to what it actually renders like when this issue is submitted.

thombruce commented 3 years ago

This issue is an example of a GitHub Issue Form submission. I'm considering using this template or similar for article submissions on other projects, but... I'm not sold, yet.

I already have a Staticman server setup that could enable article submissions easily as Pull Requests instead of as Issues from an Issue Template.

Good to know this might be an option, but it may not strictly be useful for my purposes. Maybe just Issue Templates. We'll see.

thombruce commented 3 years ago

It's worth revisiting and listing some of the comment system options for static sites that will be either more or less applicable as submissions for articles too...

Here, I've used an Issue Template to submit an Issue. The body of that Issue would need parsed manually and transferred into an actual document with additional variables. This could be automated to an extent... but it would not be the most ideal approach, certainly not for article submissions. Regardless, we'll add it to the list:

GitHub Issue Template / GitHub Issue Form
Staticman: Add any static file with configurable formatting to the repository directly (or submit as a Pull Request)
Utterances: Use GitHub Issues as a comments system
Some other options for comment systems including Disqus and Discourse: https://fedidat.com/530-blog-comments/

I really like Staticman for both comments and article submissions. Utterances is really nice only because it is LIVE and benefits from GitHub Issues' emoji reactions, which makes it a killer alternative to something like Disqus but... and it is a big BUT, commenters would require GitHub profiles. Other alternatives largely fall in the same vein as Disqus, though some might be open-source and/or self-hostable.

I guess I'm just not yet ready to be considering this, because I can't decide between a Staticman-like approach and a Disqus-like one, both of which I could program myself... so maybe I want to do that instead, but I still am not settled on an approach. Still, worth noting.

thombruce commented 3 years ago

Remark42 (mentioned by that fedidat blog link and their decision for what would serve their purposes) is a really nice open source and self-hostable solution actually: https://remark42.com/

I still don't know if it's right for my purposes but... it is good.

Y'know, I might write my own system that can do either of a Staticman-like approach or a Disqus-like one, with configurable privacy and whatnot. I could then integrate this system with DynamiteCMS... Maybe I call it Dynamite Comments or Dynamite Discussions or... something like that.

thombruce / code