WordPress.org

Making WordPress.org

Opened 7 months ago

Closed 4 months ago

Last modified 3 months ago

#2465 closed task (fixed)

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

Reported by: danielbachhuber Owned by: coffee2code
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?

Attachments (1)

2465.1.diff (9.3 KB) - added by danielbachhuber 4 months ago.

Download all attachments as: .zip

Change History (21)

#1 @danielbachhuber
7 months ago

  • Keywords wp-cli added

#2 @carl-alberto
6 months 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.


6 months ago

#4 @Kenshino
6 months 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.


6 months ago

#6 @carl-alberto
6 months ago

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

#7 @danielbachhuber
6 months 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
6 months 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
6 months ago

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

#10 in reply to: ↑ 9 ; follow-up: @samuelsidler
6 months 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
6 months 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.


5 months ago

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


5 months ago

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


4 months ago

#15 @danielbachhuber
4 months ago

2465.1.diff introduces a DevHub_CLI class which:

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

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


4 months ago

#17 @coffee2code
4 months ago

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

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.

#18 @danielbachhuber
3 months ago

In 5474:

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

See #2465

#19 @danielbachhuber
3 months ago

In 5475:

devhub/cli: Add a custom template for displaying commands

See #2465

#20 @danielbachhuber
3 months ago

In 5476:

devhub: Don't prefix command excerpts with post type

See #2465

Note: See TracTickets for help on using tickets.