Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] - plugin checklist approval blockers #709

Merged
merged 1 commit into from
Sep 11, 2023

Conversation

danmarsden
Copy link
Contributor

@danmarsden danmarsden commented Aug 24, 2023

adds some common approval blockers to the checklist - in particular the security guidelines and significant namespace collisions are typical blockers.

@mudrd8mz good to have a +1 from you (or a -1) :-)

first dev docs PR so let me know if I've got something wrong...

@netlify
Copy link

netlify bot commented Aug 24, 2023

Deploy Preview for moodledevdocs ready!

Name Link
🔨 Latest commit 1e9f7df
🔍 Latest deploy log https://app.netlify.com/sites/moodledevdocs/deploys/64fe69512a89700008e31bb0
😎 Deploy Preview https://deploy-preview-709--moodledevdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Member

@andrewnicols andrewnicols left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. I'm happy to merge it now if you want? Or you can wait for David to take a peek first. Your choice? We can always land this and then create a new issue if there is more to add.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 24, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🔴 45 🟠 87 🟢 92 🟢 90 🟢 100 Report
/docs/apis/commonfiles 🔴 41 🟠 85 🟢 92 🟢 100 🟢 100 Report
/general/development/gettingstarted 🟠 50 🟠 87 🟢 92 🟢 90 🟢 100 Report
/general/releases 🟠 52 🟠 87 🟢 92 🟢 100 🟢 100 Report

@andrewnicols
Copy link
Member

Ah - linting check is failing. This is something you can fix automatically:

yarn mdfix-all

Essentially this is complaining because you're referencing another document in the same section (general vs. docs). Where we do that we use a relative link to the markdown file because it allows better link checking.

@mudrd8mz
Copy link
Member

Many thanks @danmarsden for this. My only comment would be that the "Compliance with security guidelines" does not fit well into the "[something] that will prevent your plugin from being approved". The intention here was to list the approval blockers. So the blocker here could be something like "Violation of security guidelines" or so, no?

@andrewnicols andrewnicols added this pull request to the merge queue Sep 11, 2023
Merged via the queue into moodle:main with commit afff381 Sep 11, 2023
8 of 9 checks passed
@andrewnicols
Copy link
Member

I've amended the branch and force-pushed it.

Note: Probably best not to branch it to main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants