Skip to content

Regenerate reference for 5.4 #92

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.

Sign up for GitHub

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

Merged
merged 12 commits into from
Mar 30, 2020
Merged

Regenerate reference for 5.4 #92

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d78bb6d
Adjust reference template structure
kadamwhite Jan 2, 2020
3881e98
Add composer script for regeneration of reference
kadamwhite Jan 2, 2020
4b03586
Use a constant for the REST base for the regenerate command
kadamwhite Mar 30, 2020
aaa5254
Add more overrides and improve title generation
kadamwhite Mar 30, 2020
e73a7c5
Upgrade to Twig v3
kadamwhite Mar 30, 2020
20928f6
Add instructions for regenerating the reference
kadamwhite Mar 30, 2020
f5c688d
Update templates to use Twig v3 "title" filter
kadamwhite Mar 30, 2020
b543fd7
Adjust title & plural overrides
kadamwhite Mar 30, 2020
5816c62
Regenerate reference for WP 5.4
kadamwhite Mar 30, 2020
c24fe34
Remove debugging code
kadamwhite Mar 30, 2020
c7f1eaf
Regenerate manifest
kadamwhite Mar 30, 2020
1799c64
Use composer command in README
kadamwhite Mar 30, 2020
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add instructions for regenerating the reference
  • Loading branch information
@kadamwhite
kadamwhite committed Mar 30, 2020
commit 20928f69ba3293ffce708ce6aaeef11232a5ffab
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,13 @@ This repo contains the source for [documentation for the API](https://developer.
When creating new files, these must be added to the manifest. Run `bin/generate-manifest.php` to update this.

Removing files also requires regenerating the manifest. After deletion and sync with DevHub, the page also needs to be manually deleted from DevHub.

## Refreshing the Templated API Reference

The reference section is created by parsing the output of a site's schema as retrieved from that site's REST API index route. The current method used to generate this approach is as follows:

- Create a local WordPress environment (always use the current or Release Candidate version of WordPress) using the local environment tool of your choice.
- Edit `/etc/hosts` to map the domain `example.com` to the IP of that WordPress instance, and ensure the site is configured to run at `example.com`.
- Run `composer install` in this project's root directory to install dependencies.
- Run `bin/regenerate.php` in this project's root directory to run the asset regeneration script.
- Use `git status` and `git diff` to validate that the files were updated as expected.