WordPress.org
Get WordPress

Making WordPress.org

Opened 9 years ago

Last modified 14 months ago

#2538 assigned feature request

Plugin Directory: Preview Readme

Reported by: Ipstenu Owned by: tellyworth
Priority: high Milestone: Q2
Component: Plugin Directory Keywords: has-patch dev-feedback
Cc:

Description

It would be helpful for developers if they could proof their new readme, if a tag was in the directory already.

Example:

​https://wordpress.org/plugins/akismet/?version=14.1 would display the plugin as if it was generated by the readme in the 14.1 tag folder.

If the tag doesn't exist, the default readme is shown.

Attachments (2)

2538.diff​ (2.4 KB ) - added by tellyworth 7 years ago.
Add a simple preview to the Readme Validator
Screen Shot 2019-04-04 at 5.51.59 pm.png​ (348.4 KB ) - added by tellyworth 7 years ago.
Sample screenshot of 2538.diff in action

Download all attachments as: .zip

Change History (13)

This ticket was mentioned in ​Slack in #meta by tellyworth. ​View the logs.
9 years ago

#2 @Ipstenu
9 years ago

  • Milestone → Plugin Directory v3 - Future

#3 @tellyworth
9 years ago

  • Keywords needs-patch added
  • Priority normal → low

#4 @tellyworth
7 years ago

  • Milestone Plugin Directory v3 - Future → Q2

If we made the plugin validator display a preview, we could link to that. Displaying older readme content on the plugin page itself is unfortunately difficult.

@tellyworth
7 years ago

Add a simple preview to the Readme Validator

@tellyworth
7 years ago

Sample screenshot of 2538.diff in action

#5 @tellyworth
7 years ago

  • Keywords has-patch dev-feedback added; needs-patch removed
  • Owner set to tellyworth
  • Status new → assigned

attachment:2538.diff​ implements a simple preview function on the Readme Validator page. It simply outputs the parsed readme below the validator status messages. There's no special styling, and it doesn't show screenshots.

#6 @dd32
5 years ago

  • Priority low → high

I'm bumping the priority of this up a notch, as being able to preview/validate/understand how it's parsing a readme is actually fairly important.

Right now, the most feedback you get from the validator is absolute errors / missing fields, but it's easy to not understand it.

#7 @dd32
5 years ago

In 10796:

Plugin Directory: Readme Validator: Allow passing the readme URL through a GET parameter to make linking to readme examples easier.

See #2538.

This ticket was mentioned in ​Slack in #meta by dd32. ​View the logs.
5 years ago

#10 @dd32
4 years ago

  • Type enhancement → feature request

#11 @davidperez
14 months ago

To keep it maintainable, we could use PCP to analyze the readme and extract results from it. Since we already have many checks in place, we can combine them with the ones that are needed.

What do you think?

Note: See TracTickets for help on using tickets.