Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Potential to work with plugin portal/directory

Some potential areas of documentation:

  • What can be overridden by replacement in the plugin's directory (e.g., .erbs in views/) and what can't (e.g. .rbs in controllers)
    • and what to do about overriding behavior in the latter (e.g.: using Foo..module_eval do in the plugin_init.rb to add/override functionality)
    • Can routes be overriden, or just concatenated; if the former, how to do it.
  • Best practices if you expect to have more than one plugin (e.g.: what happens if you have two plugins, each of which need to add a button to the same page?)
  • Writing messages to the log file
  • For the advanced developer, being given a better understanding of when/where the various parts of the plugin get "read into" ArchivesSpace, so that debugging is less fraught. (Example from today: it seems that my frontend/schemas/my_pretty_good_job.rb isn't getting read in; it would be really nice to know where to look!)

3. Make it easier to contribute to tech docs

...