Define module specification in documentation#26
Merged
felixarntz merged 4 commits intotrunkfrom Dec 2, 2021
Merged
Conversation
felixarntz
requested review from
ThierryA,
adamsilverstein,
aristath,
audrasjb,
josephscott and
tillkruss
Member
|
LGTM. |
ThierryA
approved these changes
Dec 1, 2021
JustinyAhin
approved these changes
Dec 2, 2021
Member
JustinyAhin
left a comment
JustinyAhin
left a comment
There was a problem hiding this comment.
Good docs. It looks fine for me.
aristath
approved these changes
Dec 2, 2021
tillkruss
approved these changes
Dec 2, 2021
Member
|
Should the notices be dismissible? |
Member
Author
|
@tillkruss That notice is only a random code example, just to have any code in the demo module. For example if you just start your module with that file, seeing that notice will tell you that you did things right. :) So it doesn't really matter, our actual modules probably shouldn't contain admin notices in the first place. |
felixarntz
added
[Type] Documentation
felixarntz
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a
/docsfolder with an initial article detailing the module specification, with minimum requirements and recommendations for writing a module for the performance plugin.The documentation includes a minimal demo module file, as clarification and a potential starting point for any module.
Preview the documentation here.
Fixes #2