FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Define module specification in documentation by felixarntz · Pull Request #26 · WordPress/performance · GitHub

/ performance Public

Define module specification in documentation - #26

Merged
felixarntz merged 4 commits into
trunkfrom
add/2-writing-a-module-docs
Dec 2, 2021
ConversationCommits (4)ChecksFiles changed
Merged

Define module specification in documentation#26
felixarntz merged 4 commits into
trunkfrom
add/2-writing-a-module-docs

Conversation

felixarntz commented Dec 1, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

This PR adds a /docs folder 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

felixarntz mentioned this pull request Dec 1, 2021
Closed

ThierryA commented Dec 1, 2021

Copy link
Copy Markdown
Member

LGTM.

felixarntz mentioned this pull request Dec 2, 2021
Merged
JustinyAhin self-requested a review December 2, 2021 07:54
JustinyAhin approved these changes Dec 2, 2021
View reviewed changes

JustinyAhin left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Good docs. It looks fine for me.

adamsilverstein approved these changes Dec 2, 2021
View reviewed changes

adamsilverstein left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

👍🏼 Nice work!

tillkruss commented Dec 2, 2021

Copy link
Copy Markdown
Member

Should the notices be dismissible?

felixarntz commented Dec 2, 2021

Copy link
Copy Markdown
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 merged commit fd8a2a6 into trunk Dec 2, 2021
felixarntz added [Type] Documentation Documentation to be added or enhanced Infrastructure Issues for the overall performance plugin infrastructure labels Dec 6, 2021
felixarntz added this to the Initial plugin release milestone Dec 6, 2021
felixarntz changed the title Add module specification in documentation Define module specification in documentation Dec 6, 2021
tillkruss deleted the add/2-writing-a-module-docs branch March 7, 2022 19:27
gerardv mentioned this pull request Feb 18, 2023
Closed
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

aristath aristath approved these changes
tillkruss tillkruss approved these changes
adamsilverstein adamsilverstein approved these changes
ThierryA ThierryA approved these changes
JustinyAhin JustinyAhin approved these changes
josephscott Awaiting requested review from josephscott
audrasjb Awaiting requested review from audrasjb

Assignees

No one assigned

Labels

Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Milestone

1.0.0-beta.1

Development

Successfully merging this pull request may close these issues.

Define basic module specification

6 participants

Back | FazBrowse Home | New Git URL