Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create readme.txt #542

Merged
merged 1 commit into from
Mar 18, 2020
Merged

Create readme.txt #542

merged 1 commit into from
Mar 18, 2020

Conversation

jeffpaul
Copy link
Member

Description of the Change

This PR adds a readme.txt file, but not with ALL the details normally included for plugins distributed to WordPress.ORG mainly to avoid having to keep this in-sync with README.md though ensuring we display enough details through the plugin update checker as relevant for users in WP Admin.

Alternate Designs

n/a

Benefits

Ensures we display tested-up-to, requires-at-least, and description details in WP Admin.

Possible Drawbacks

None identified.

Verification Process

Manually verified via the GitHub web UI.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

Closes #541

Changelog Entry

n/a

@jeffpaul jeffpaul added the needs:documentation This requires documentation. label Mar 10, 2020
@jeffpaul jeffpaul added this to the 2.0.0 milestone Mar 10, 2020
@jeffpaul jeffpaul self-assigned this Mar 10, 2020
@dinhtungdu
Copy link
Contributor

@jeffpaul Currently I can't see the content of readme.txt anywhere in the WP Admin area. Click on Plugins > View details (of Distributor) and see only the short description (https://prnt.sc/rgx0h5). Look like only w.org plugins are supported there.

@jeffpaul
Copy link
Member Author

@dinhtungdu correct, though when you're notified of a plugin update some details are displayed there. Example w/ClassifAI: https://cloudup.com/c-Ofaa7Zs3f

@jeffpaul jeffpaul merged commit bce44a5 into develop Mar 18, 2020
@jeffpaul jeffpaul deleted the add/readme-txt branch June 30, 2020 01:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:documentation This requires documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add readme.txt file
2 participants