Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor to mimic wp-cli docs process #9

Open
jeffpaul opened this issue Jun 7, 2018 · 3 comments

Comments

@jeffpaul
Copy link
Member

commented Jun 7, 2018

See: https://github.com/wp-cli/handbook/. Specifically:

All documentation is imported automatically into WordPress.org in a two step process:

  1. WordPress reads commands-manifest.json or handbook-manifest.json to understand all pages that need to be created.
  2. Each WordPress page has a markdown_source attribute specifying a Markdown file to be fetched, converted to HTML, and saved in the database.

For make.wordpress.org/cli, the import process is a WordPress plugin running a WP Cron job every 15 minutes. For developer.wordpress.org/cli, this is a class in the devhub theme running a WP Cron job every 12 hours.

Our current docs site is being spun up quickly for WCEU, but as we look to refactor that to be a more maintainable site we should consider recommendations from other WP teams. We can check with the Meta and Support teams to see if they have any best practice recommendations.

@jeffpaul jeffpaul added the enhancement label Jun 7, 2018

@jeffpaul jeffpaul self-assigned this Jun 7, 2018

@jeffpaul

This comment has been minimized.

Copy link
Member Author

commented Aug 29, 2018

Per bugscrub today, we're keeping this in the 1.0.0 release as it's part of the work that is still left to fix the build process for the docs site.

@jeffpaul

This comment has been minimized.

Copy link
Member Author

commented Dec 9, 2018

There's also a wp-github-sync plugin (and a couple other plugins/theme tweaks) that could be used to keep markdown files in a GitHub repo synchronized with posts in WordPress. I've functionally proven that in a local environment and personal repo, so if we decide to alter our process and stop using docpress then I've found another option for us.

@valendesigns

This comment has been minimized.

Copy link
Member

commented Feb 27, 2019

Right now we've got the docs in a pretty good place and probably will not be making this change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.