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 · 6 comments
Open

Refactor to mimic wp-cli docs process #9

jeffpaul opened this issue Jun 7, 2018 · 6 comments
Assignees
Labels
Contributor Day enhancement New feature or request good first issue Good for newcomers

Comments

@jeffpaul
Copy link
Member

jeffpaul 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 New feature or request label Jun 7, 2018
@jeffpaul jeffpaul self-assigned this Jun 7, 2018
@jeffpaul
Copy link
Member Author

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 jeffpaul added good first issue Good for newcomers and removed hacktoberfest labels Nov 28, 2018
@jeffpaul
Copy link
Member Author

jeffpaul 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
Copy link
Contributor

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

@jeffpaul
Copy link
Member Author

I worked on refactoring the docs to remove docpress and simplify to GitHub Pages, just waiting on the GitHub Pages deployment process to catch up to all my commits. My forked repo is here: https://github.com/jeffpaul/docs. Sample docs site is here: https://jeffpaul.github.io/docs/. If I can get things cleaned up a bit (once GitHub Pages deploys catch up to my commits), then I’ll open a PR to merge my changes upstream and we can assign the wptide.org domain to the GitHub Page and be done with the docpress mess.

@derekherman
Copy link
Member

@jeffpaul how is this going to work as a WordPress theme?

@jeffpaul
Copy link
Member Author

@derekherman skipping WP, having docs live separately as their own repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributor Day enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants