Gatsby: [Discussion]: Improve contribution process for docs (remove linting?)

[jsjoeio]

Summary

Recently, I made the PR using GitHub's web interface to edit the Gatsby docs markdown file directly. However, in order for it to pass and be approved, I had to fix linting. To do this, I needed to pull down the repo, run the linter, then update my PR.

I didn't mind doing this at all, but I think this process could be improved.

If someone wants to update the docs, they should be able to do so by directly editing the file and submitting a PR.

Relevant information

I spoke with @shannonbux and she suggested I start a discussion around this idea of improving the contributing process for Gatsby.

Proposed Solution

Maybe we could modify the linting process to ignore Markdown files? Or somehow have a way for the contributor to run the linter within the browser?

I'm probably lacking more information but throwing these ideas out there.

[pieh]

Yeah, we had conversation about this today even before you created this issue and agree this really is pain point. I think what we will do is for now disable linting for markdown until we will have a way for @gatsbybot to run prettier (on demand so it doesn't mess with people PRs if not asked for) and push any formatting changes back to PR

[pieh]

PR - https://github.com/gatsbyjs/gatsby/pull/10293

[jsjoeio]

Good idea, @pieh!

[pieh]

I've been working over the weekend on format bot for gatsby repo and have working proof of concept for on-demand formatting with our peril bot (sorry for bad quality - I used one of those mp4 to gif online converters, but should show the flow):

It should support all the things that we lint/format ( https://github.com/pieh/peril-testing/blob/219cedecc673620bf71a04e6d443c530d578cf1a/rules/handle-comment-commands.ts#L228-L235 ).

I've been testing this on my fork - https://github.com/pieh/gatsby/pulls - If someone want to try - please open PR there that would need formatting (in .md, .js or .y(a)ml files) and create comment with format word in it (currently bot is running on my local machine, so it's not always online - but it should be for at least few next hours)

[gatsbot[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 30 days of inactivity. It’s been at least 20 days since the last update here.

If we missed this issue or if you want to keep it open, please reply here. You can also add the label "not stale" to keep this issue open!

Thanks for being a part of the Gatsby community! 💪💜

[gatsbot[bot]]

Hey again!

It’s been 30 days since anything happened on this issue, so our friendly neighborhood robot (that’s me!) is going to close it.

Please keep in mind that I’m only a robot, so if I’ve closed this issue in error, I’m HUMAN_EMOTION_SORRY. Please feel free to reopen this issue or create a new one if you need anything else.

Thanks again for being part of the Gatsby community!