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

[danielbachhuber]

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?

[carl-alberto]

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

[Kenshino]

Somewhere in DevHub probably.

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

[carl-alberto]

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

[danielbachhuber]

@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.

[samuelsidler]

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.

[danielbachhuber]

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

[samuelsidler]

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.)

[danielbachhuber]

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.

[danielbachhuber]

2465.1.diff introduces a DevHub_CLI class which:

• Registers a command post type
• Introduces two WP cron jobs to import command documentation from ​http://github.com/wp-cli/handbook/

@coffee2code Does this look reasonable to you? I think I can commit directly to the theme, but want to run it by you first.

[coffee2code]

In 5469:

developer.wordpress.org: Register command post type and cron jobs for importing command documentation.

For wp-cli command documentation.

Props danielbachhuber.
Fixes #2465.

[danielbachhuber]

In 5474:

devhub/cli: Add a basic /cli/commands/ archive page

See #2465

[danielbachhuber]

In 5475:

devhub/cli: Add a custom template for displaying commands

See #2465

[danielbachhuber]

In 5476:

devhub: Don't prefix command excerpts with post type

See #2465