https://github.com/godaddy-wordpress/woocommerce-memberships-rest-api-docs
WooCommerce Memberships REST API Documentation
https://github.com/godaddy-wordpress/woocommerce-memberships-rest-api-docs
memberships rest-api-documentation woocommerce
Last synced: 4 months ago
JSON representation
WooCommerce Memberships REST API Documentation
- Host: GitHub
- URL: https://github.com/godaddy-wordpress/woocommerce-memberships-rest-api-docs
- Owner: godaddy-wordpress
- License: other
- Created: 2018-07-10T15:27:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-04-12T09:26:10.000Z (over 2 years ago)
- Last Synced: 2025-01-21T02:11:13.567Z (6 months ago)
- Topics: memberships, rest-api-documentation, woocommerce
- Language: SCSS
- Homepage: https://godaddy-wordpress.github.io/woocommerce-memberships-rest-api-docs/
- Size: 262 KB
- Stars: 10
- Watchers: 24
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## WooCommerce Memberships REST API documentation
_Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API._
[Follow this link](https://godaddy-wordpress.github.io/woocommerce-memberships-rest-api-docs/) to read the **REST API documentation**.
> If you are looking for the general **plugin documentation**, [please follow this link](https://docs.woocommerce.com/document/woocommerce-memberships/).
### Contributing
You can contribute to this documentation by:
* [Opening an issue](https://github.com/godaddy-wordpress/woocommerce-memberships-rest-api-docs/issues/new) to report a problem or information missing, etc.
* Opening a pull request to extend the documentation.
> Please **do not submit feature requests or support requests for the REST API** here. You can use the [WooIdeas board](http://ideas.woocommerce.com/forums/133476-woocommerce?category_id=125014) or [Contact SkyVerge support](https://www.skyverge.com/support/).
### Running locally
#### Natively
```shell
bundle install
```
> **Important note:** if you run into `bundle install` errors, you may need to install `ruby-devel` and install the related gems again to build native extensions.
Then, to test changes locally run:
```shell
bundle exec middleman server
```
#### Via Docker
1. Build the docker image:
```shell
docker build . -t docs
```
1. Start the image:
```shell
docker run -d --rm --name docs -p 4567:4567 -v $(pwd)/build:/srv/docs/build -v $(pwd)/source:/srv/docs/source docs
```
You will be able to access your site at http://localhost:4567.
To build your sources while the container is running, run:
```shell
docker exec -it docs /bin/bash -c "bundle exec middleman build"
```
### Updating pages
This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
Follow [Slate readme](https://github.com/lord/slate/blob/master/README.md) and [wiki](https://github.com/lord/slate/wiki) for instructions on how to edit files and make changes.
### Deploying an update
#### GitHub Action
A `deploy` GitHub action is triggered automatically when changes are pushed to `main` or `master` branches. No manual action is normally required.
#### Deploy script
If the GitHub action fails, after pushing changes, you can deploy using the script:
```shell
bash deploy.sh
```