search

InnerSourceCommons / InnerSourceLearningPath

Holds the source material for the InnerSource Commons Learning Path
https://innersourcecommons.org/learningpath
Creative Commons Attribution Share Alike 4.0 International
74 stars 46 forks source link

Fix Vale typos #592

Closed rrrutledge closed 1 year ago

rrrutledge commented 1 year ago

@spier there is just one issue left that Vale has flagged, and I'm not sure how to correct it. Can you take a look? It is some markup that it interprets as an incorrect spelling of InnerSource.

spier commented 1 year ago

@spier there is just one issue left that Vale has flagged, and I'm not sure how to correct it. Can you take a look? It is some markup that it interprets as an incorrect spelling of InnerSource.

Very cool that you did all these fixes. Great job @rrrutledge!

I also saw the issue that you mentioned in contributor/02-becoming-a-contributor-article.asciidoc.

vale cannot understand the in-word italic formatting of Inner Source in asciidoc. Aside: Looks like such formatting cannot even be expressed here in GitHub markdown in one word at all.

An option could be to switch off the specific vale rule just for the line in that file. Looks like it should be possible. I will test this in your branch here shortly, hope you don't mind :)

spier commented 1 year ago

See the last commit for the fix I applied.

It looks like it worked 🥳

The Filtered Findings section of the vale report now show 0 issues, as compared to 1 issue that was there before.

I cannot confirm if the changes I made create any regressions in the rendered version of the LearningPath on the website. @rrrutledge How to check that?

rrrutledge commented 1 year ago

Thanks, @spier ❗️ I’ll try it out

rrrutledge commented 1 year ago

It works! Translates to an HTML comment just fine. Will merge now.