Skip to content

Added "Sort plugins or themes by certain column(s)" to "Snippets"#446

Merged
danielbachhuber merged 1 commit intowp-cli:mainfrom
porg:patch-4
Jun 1, 2023
Merged

Added "Sort plugins or themes by certain column(s)" to "Snippets"#446
danielbachhuber merged 1 commit intowp-cli:mainfrom
porg:patch-4

Conversation

@porg
Copy link
Contributor

@porg porg commented May 31, 2023

  • In the H2 section "Snippets" I transformed all sub-sections into proper H3s, to get proper permanent anchor-links for easy linking and a TOC (as it grows over time!)
  • Then I added my particular H3: Sort plugins or themes by certain column(s)

@porg
Added "Sort plugins or themes by certain column(s)" to "Snippets"
de51f4a 
- In the H2 section "Snippets" I transformed all sub-sections into proper H3s, to get proper permanent anchor-links for easy linking and a TOC (as it grows over time!)
- Then I added my particular H3: Sort plugins or themes by certain column(s)
@porg porg requested a review from a team as a code owner May 31, 2023 08:17
@porg porg mentioned this pull request May 31, 2023
Closed
@porg
Copy link
Contributor Author

porg commented May 31, 2023

One more question: Which manpages/sections link to shell-friends.md ?

  • When I search for shell-friends.md in the repo I currently only find the file itself, and an entry in the manifest. But no incoming links.

  • If it has no incoming links from a main help document, no-one will ever discover the content.

  • Glad for any info on that.

@danielbachhuber danielbachhuber added this to the 2.8.0 milestone May 31, 2023
@danielbachhuber danielbachhuber modified the milestones: 2.8.0, 2.9.0 Jun 1, 2023
@danielbachhuber
Copy link
Member

danielbachhuber commented Jun 1, 2023

Looks great, thanks!

One more question: Which manpages/sections link to shell-friends.md ?

It's linked to from these pages:

@danielbachhuber danielbachhuber merged commit cdc47b2 into wp-cli:main Jun 1, 2023
@porg
Copy link
Contributor Author

porg commented Jun 1, 2023

shell-friends.md is linked to from these pages:

https://make.wordpress.org/cli/handbook/
https://make.wordpress.org/cli/handbook/guides/quick-start/
https://make.wordpress.org/cli/handbook/contributions/philosophy/

Is it also mentioned from somewhere within the command line help itself?

  • It should be IMHO.
  • I did not see it mentioned on wp help?
  • Possibly somewhere within a particular wp help command page, but i did not know how to search fro that in the github codebase.

@danielbachhuber
Copy link
Member

danielbachhuber commented Jun 1, 2023

Is it also mentioned from somewhere within the command line help itself?

It's not, no. It might make sense to link to the handbook from wp help, but probably not an individual document.

@porg
Copy link
Contributor Author

porg commented Jun 1, 2023 •
edited
Loading

Maybe at the very bottom of wp help insert

SEE ALSO:

wp help shell-friends — Get some tips & tricks how you can make the most of wp-cli in combination with other CLI apps. Composability is a key philosophy of WP-CLI!

Or if not made available as a help page of the app, then:

SEE ALSO:

https://make.wordpress.org/cli/handbook/references/shell-friends/

Get some tips & tricks how you can make the most of wp-cli in combination with other CLI apps. Composability is a key philosophy of WP-CLI!

  • Many Terminal apps allow clicking hyperlinks (with right-click or click + modifier key).
  • Or copy and pasting into a web browser will also do.
  • Certainly this measure would help discoverability a bit.

@danielbachhuber
Copy link
Member

danielbachhuber commented Jun 1, 2023

@porg Can you open a new issue for some discussion? https://github.com/wp-cli/wp-cli/issues

@porg
Copy link
Contributor Author

porg commented Jun 1, 2023

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@danielbachhuber danielbachhuber danielbachhuber approved these changes

Assignees

No one assigned

Labels

scope:documentation

Projects

None yet

Milestone

2.9.0

Development

Successfully merging this pull request may close these issues.

2 participants

@porg @danielbachhuber