WordPress.org

Making WordPress.org

Opened 6 years ago

Closed 5 years ago

#180 closed enhancement (fixed)

Ability to submit examples on function pages

Reported by: samuelsidler Owned by: coffee2code
Milestone: Priority: lowest
Component: Developer Hub Keywords:
Cc:

Description

The code reference should have the ability to submit examples of how to use a function properly. These examples should be curated before getting published broadly. This will need design work and a team of people to curate examples, in addition to development work for the feature.

As part of this, we should consider adding up/down-voting of published examples. (Note that there are plugins that can be modified for up/down-voting if we choose to do that.)

Attachments (1)

wp-doc.zip (6.4 KB) - added by nacin 6 years ago.

Download all attachments as: .zip

Change History (11)

#1 @DrewAPicture
6 years ago

  • Cc xoodrew@… added

@nacin
6 years ago

#2 follow-up: @nacin
6 years ago

The original theme from georgestephanis, uploaded here as wp-doc.zip, more or less had this. But examples are a far lower priority to having most other tasks completed, and probably should *not* be a v1 feature, if only to make sure we get the reference bits of this site where we want it before we open the floodgates.

#3 @samuelsidler
6 years ago

  • Priority changed from low to lowest

#4 in reply to: ↑ 2 ; follow-up: @siobhan
6 years ago

Replying to nacin:

The original theme from georgestephanis, uploaded here as wp-doc.zip, more or less had this. But examples are a far lower priority to having most other tasks completed, and probably should *not* be a v1 feature, if only to make sure we get the reference bits of this site where we want it before we open the floodgates.

The ability to add examples and explanations is part of the original specification and without them we won't have a completed v1. The intention is not to purely have a reference but to have an educational tool. Also, once v1 is completed we should be in a position to start moving content from the Codex and shutting down many of the pages there.

I agree, though, that voting can definitely come later.

#5 @siobhan
6 years ago

  • Cc siobhan added

#6 in reply to: ↑ 4 @nacin
6 years ago

Replying to siobhan:

The ability to add examples and explanations is part of the original specification and without them we won't have a completed v1. The intention is not to purely have a reference but to have an educational tool. Also, once v1 is completed we should be in a position to start moving content from the Codex and shutting down many of the pages there.

I think a v1 is feature-completeness of the "reference" part. And there is a lot to do, both in terms of navigation/discoverability and extracting/presenting as much valuable information as possible. I also think that *having* examples in v1 is good, but is different from opening the floodgates for anyone to submit an example. The last thing we want is for there to be a cesspool of bad examples (like the Codex) either waiting to be reviewed, or just as bad, quickly and indiscriminately published.

#7 @siobhan
6 years ago

  • Owner set to coffee2code
  • Status changed from new to assigned

#8 @coffee2code
5 years ago

In 724:

Code Reference: add ability for users to submit code examples (via comments). See #180

Viewable by all, but temporarily only submittable by members of the site.

#10 @coffee2code
5 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

Fixed now that submitting user contributed notes is open to any WP.org user (all submissions are moderated).

Note: See TracTickets for help on using tickets.