Skip to content

Plugin install intructions #227

Description

@agentofreality

Now that Sources, Reactions etc are plugins, we need to include installation instructions on their documentation pages.

Figure out how best to provide these instructions for all plugins that exist at the time of resolution. Consider these approaches:

  • A single update that is applicable to all plugins
  • Instructions per plugin type
  • Instructions for individual plugins

In any case, the instructions must be easily accessible (embedded or linked) for each plugin.

Also decide:

  • what needs to go in a plugins readme
  • do the various developer guides need to be updated to tell developers how installations should work
  • do installation instructions need to be a checklist item in the developer guides.
  • can the installation instructions be automated, does this require special guidance for developers

How to make sure all future plugins follow a consistent approach to include installation instructions

Depending on the decided approach, this issue might need sub issues, or to be broken into multiple isses.

Acceptance criteria

  • All plugins have installation instructions that are embedded / linked that are easy for a user to locate and simple to follow
  • Process to ensure all future plugins provide installation instructions, ideally using a consistent approach
  • Updated guidance / checklists in developer guides if required
  • Automated tests that follow written instructions and validate the plugin installation works

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions