[abgreeve]

No description provided.

[netlify]

✅ Deploy Preview for moodledevdocs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	bd363d4
🔍 Latest deploy log	https://app.netlify.com/sites/moodledevdocs/deploys/62d7547a24923000099e3382
😎 Deploy Preview	https://deploy-preview-314--moodledevdocs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[github-actions]

⚡️ Lighthouse report for the deploy preview of this PR

URL	Performance	Accessibility	Best Practices	SEO	PWA	Report
/	🟠 80	🟢 98	🟢 100	🟢 90	🟢 100	Report
/docs/apis/commonfiles	🟠 71	🟢 96	🟢 100	🟢 100	🟢 100	Report
/general/development/gettingstarted	🟠 87	🟢 96	🟢 100	🟢 90	🟢 100	Report
/general/releases	🟠 79	🟢 96	🟢 100	🟢 100	🟢 100	Report

[andrewnicols]

Just the changes to the component-spelling.txt in the wrong place. Otherwise this is good to go.

[stronk7]

Hi, nice addition, well done!

Just a side note, for your consideration... I had this here in my TODOs...

Link (not sure it works, first time I try it ever): Moodle Developer Resources chat.

Original comment:

Q: Looking to #248 I had plans to give it a try with https://docs.moodle.org/dev/Backup_API (one of the elements in the list).

Problem (conceptually) that I'm facing is that, from when I did look for related dev docs recently (marking some of the pages like "not to migrate). I came with this list about pages to migrate:

==== 100% sure:

• https://docs.moodle.org/dev/Backup_API
• https://docs.moodle.org/dev/Backup_2.0_for_developers
• https://docs.moodle.org/dev/Restore_API
• https://docs.moodle.org/dev/Restore_2.0_for_developers

==== Not so sure:

• https://docs.moodle.org/dev/Backup_2.0_theme_data
• https://docs.moodle.org/dev/Backup_2.0_course_report_data

So, the question is... what should go to the "canonical" /docs/apis/subsystems/backup/index.md new page. Just an intro and then link to others... or maybe everything together? Or, how do we split backup and restore?

I mean, I'm not sure about which the structure should be.

Just sharing here in case we want to do anything with those other pages (migrate, obsolete... whatever). Not the original question about locations.

Ciao :-)

[andrewnicols]

Thanks Eloy,

I'm getting to be of the opinion that perfect is the enemy of good - that is that we're better off at this time to get as many docs moved over as quickly as possible and then to refine and improve them later.

We definitely want to move some/all of those other pages and/or merge them into the recently migrated ones. I'm also of the opinion that we should be writing a developer guide as well.

I see the two being slightly different:

• docs/apis/subsystems - information on subsystems, how to use them, and key points
• docs/apis/plugintypes - information for those developing a plugintype, and key points
• docs/guides - walkthroughs on how to do a common action or use a common API from start to end - useful for more detailed items like the JavaScript guide, or the Templating guide, or other more general concepts.