Summary

Pine now has the ability to automatically check whether any changes done to your repo's documentation will be rejected by Pine (and Docusaurus) as a result of bad Markdown. It does this through an Evergreen task that is automatically triggered when a parent patch (i.e a PR in your repo) is created. This will prevent you from merging changes that will cause issues in Pine. However, we do require some setup on your end to enable this functionality for your repo.

Please follow the instructions here: https://docs.devprod.prod.corp.mongodb.com/pine/onboarding/#incorporating-pines-evergreen-task 

Motivation

Who is the affected end user?

Pine viewers, developers, and maintainers

How does this affect the end user?

Are they blocked? Are they annoyed? Are they confused?

Makes Pine easier to deploy and debug. Reduces amount of time Services & Integrations has to spend commenting out a repo/filing a ticket to the appropriate team.

How likely is it that this problem or use case will occur?

Main path? Edge case?

Possible whenever changes to documentation are made and bad Markdown is introduced

If the problem does occur, what are the consequences and how severe are they?

Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

Not very severe. Your repo's documentation will become unavailable on Pine and be replaced with a 404 page. You'll also get notified by S&I.

Is this issue urgent?

Does this ticket have a required timeline? What is it?

No required timeline, but would be good to do it soonish as it is not complex. 

Is this ticket required by a downstream team?

Needed by e.g. Atlas, Shell, Compass?

No

Is this ticket only for tests?

Does this ticket have any functional impact, or is it just test improvements?

Test improvements

Acceptance Criteria

What specific requirements must be met to consider the design phase complete?

Pine's Evergreen task now automatically runs whenever a PR is created and changes are done in the PR branch of your repo.