WordPress.org

Making WordPress.org

Opened 8 weeks ago

Last modified 2 weeks ago

#2465 new task

Create new WPorg home for wp-cli.org/commands and wp-cli.org/docs/internal-api

Reported by: danielbachhuber Owned by:
Milestone: Priority: normal
Component: Developer Hub Keywords: wp-cli
Cc:

Description

Now that the handbook has been migrated to make/cli, we need to create a new WPorg home for wp-cli.org/commands and wp-cli.org/docs/internal-api.

Some qualifiers:

  • Both of these collections are generated from the WP-CLI codebase on every release.
  • Eventually, the /commands/ directory should also include documentation from commands in the package index (not necessarily bundled with WP-CLI core).
  • It might be easier to generate a JSON blob of documentation data, store that in the WP-CLI handbook repo, and have WPorg create command and internal API pages from the JSON blob.

What's the best location on WPorg for these docs, and how do we get from here to there?

Change History (13)

#1 @danielbachhuber
8 weeks ago

  • Keywords wp-cli added

#2 @carl-alberto
8 weeks ago

Hi Daniel, I would love to help out in the documentation for the WP-cli, I guess a good place to start is asking anyone from the slack docs channel, We'll try to ask around to get this started

This ticket was mentioned in Slack in #docs by carl-alberto. View the logs.


8 weeks ago

#4 @Kenshino
8 weeks ago

  • Component changed from General to Developer Hub
  • Type changed from enhancement to task

Somewhere in DevHub probably.

Gotta think how to work this. @samuelsidler @drewapicture - any thoughts?

This ticket was mentioned in Slack in #cli by kenshino. View the logs.


8 weeks ago

#6 @carl-alberto
8 weeks ago

Thanks @Kenshino , I'll definitely check out Docs meeting for feedback!

#7 @danielbachhuber
5 weeks ago

@Kenshino @samuelsidler @drewapicture Unless there are objections, I'd like to move ahead with https://developer.wordpress.org/commands/ as the directory of commands, and https://make.wordpress.org/cli/internal-api/ for the internal API documentation.

Both would be fed by JSON data from a GitHub repo, to avoid needing to run a WP-CLI command directly against the WordPress.org database.

#8 @samuelsidler
5 weeks ago

Why https://developer.wordpress.org/commands/ versus https://developer.wordpress.org/cli/commands/ or something similar? Seems weird to have it as a top-level item.

#9 follow-up: @danielbachhuber
5 weeks ago

Isn't the cli in https://developer.wordpress.org/cli/commands/ redundant?

#10 in reply to: ↑ 9 ; follow-up: @samuelsidler
5 weeks ago

Replying to danielbachhuber:

Isn't the cli in https://developer.wordpress.org/cli/commands/ redundant?

Perhaps I don't know what it means. I thought this was the list of commands for the command line interface of WordPress, not the list of commands for all of WordPress. Nothing in https://developer.wordpress.org/commands/ says it's for the CLI interface. I don't see how it's redundant. (Also "command line interface" is not the same "commands", especially in context.)

#11 in reply to: ↑ 10 @danielbachhuber
5 weeks ago

Replying to samuelsidler:

Perhaps I don't know what it means. I thought this was the list of commands for the command line interface of WordPress, not the list of commands for all of WordPress. Nothing in https://developer.wordpress.org/commands/ says it's for the CLI interface. I don't see how it's redundant. (Also "command line interface" is not the same "commands", especially in context.)

Fair enough.

This ticket was mentioned in Slack in #meta by danielbachhuber. View the logs.


2 weeks ago

This ticket was mentioned in Slack in #meta-devhub by danielbachhuber. View the logs.


2 weeks ago

Note: See TracTickets for help on using tickets.