Making WordPress.org

Opened 6 years ago

Closed 6 years ago

Last modified 17 months ago

#3819 closed defect (bug) (fixed)

Plugin 'Installation' section gets automatically added to FAQ section

Reported by: duanestorey's profile duanestorey Owned by: dd32's profile dd32
Milestone: Priority: normal
Component: Plugin Directory Keywords:
Cc:

Description

I recently released a plugin, and noticed that my == Installation == section automatically gets added to the first item in the FAQ. I moved the == Installation == section around, thinking it would fix it, but it didn't..

I went and looked at a few other plugins via the WordPress admin, and they also seem to have the same issue - the Installation instructions are repeated in the FAQ. I assume this is a bug because it seems redundant otherwise.

Attachments (4)

Screen Shot 2018-09-20 at 8.45.44 PM.png (1.2 MB) - added by duanestorey 6 years ago.
WordPress Mobile Pack, Installation Tab
Screen Shot 2018-09-20 at 8.45.48 PM.png (1.2 MB) - added by duanestorey 6 years ago.
WordPress Mobile Pack, FAQ Tab, with install repeated
Screen Shot 2018-09-20 at 8.46.03 PM.png (235.0 KB) - added by duanestorey 6 years ago.
Role Scoper plugin, Installation Instructions
Screen Shot 2018-09-20 at 8.46.07 PM.png (341.5 KB) - added by duanestorey 6 years ago.
Role Scoper plugin, FAQ, showing repeated Installation instructions

Change History (12)

@duanestorey
6 years ago

WordPress Mobile Pack, Installation Tab

@duanestorey
6 years ago

WordPress Mobile Pack, FAQ Tab, with install repeated

@duanestorey
6 years ago

Role Scoper plugin, Installation Instructions

@duanestorey
6 years ago

Role Scoper plugin, FAQ, showing repeated Installation instructions

#1 @duanestorey
6 years ago

  • Component changed from General to Plugin Directory

#2 @Otto42
6 years ago

This is intentional, it's an artifact of the single page design we originally had. The installation section exists both as the first FAQ section as well as its own tab.

#3 @duanestorey
6 years ago

Is it something that can be improved, i.e. if the design no longer has that constraint? My first thought was there was something wrong as a plugin author since it was being duplicated twice.

#4 @Otto42
6 years ago

Realistically, if you don't have any special installation instructions, I'd say to leave the section out of your readme.txt entirely. It is not a required section, and most people install through the auto installer, or through the ZIP file uploader.

#5 @duanestorey
6 years ago

Ok well, I'm happy to take a stab at submitting a patch if there are is anything that needs to be cleaned up.

But I can certainly remove it from my readme files for now. Thanks.

#6 @dd32
6 years ago

  • Owner set to dd32
  • Resolution set to fixed
  • Status changed from new to closed

In 7697:

Plugin Directory: Stop appending the Installation Instructions section to the FAQ as the tab now exists again.

This will take effect for plugins upon their next import (when they make an SVN commit usually).

Fixes #3819.

#7 @SergeyBiryukov
5 years ago

#2807 was marked as a duplicate.

#8 @dd32
17 months ago

In 12316:

Plugin Directory: Restore the 'installation' tab content heading within the tab.

Resolves a PHP Notice.
See #3819.

Note: See TracTickets for help on using tickets.