You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-9Lines changed: 15 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# WooCommerce Memberships REST API documentation
1
+
##WooCommerce Memberships REST API documentation
2
2
3
-
Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API.
3
+
_Official repository for the documentation of the [WooCommerce Memberships](https://woocommerce.com/products/woocommerce-memberships/) REST API._
4
4
5
5
[Follow this link](https://skyverge.github.io/woocommerce-memberships-rest-api-docs/) to read the **REST API documentation**.
6
6
7
7
> If you are looking for the general **plugin documentation**, [please follow this link](https://docs.woocommerce.com/document/woocommerce-memberships/).
8
8
9
-
## Contributing
9
+
###Contributing
10
10
11
11
You can contribute to this documentation by:
12
12
@@ -15,9 +15,9 @@ You can contribute to this documentation by:
15
15
16
16
> 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/).
17
17
18
-
## Running locally
18
+
###Running locally
19
19
20
-
### Natively
20
+
####Natively
21
21
22
22
```shell
23
23
bundle install
@@ -31,7 +31,7 @@ Then, to test changes locally run:
31
31
bundle exec middleman server
32
32
```
33
33
34
-
### Via Docker
34
+
####Via Docker
35
35
36
36
1. Build the docker image:
37
37
```shell
@@ -49,15 +49,21 @@ To build your sources while the container is running, run:
This project uses [Slate](https://github.com/lord/slate) for building the documentation pages.
55
55
56
56
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.
57
57
58
-
## Deploying an update
58
+
### Deploying an update
59
59
60
-
After pushing changes and you are ready to deploy use the script:
60
+
#### GitHub Action
61
+
62
+
A `deploy` GitHub action is triggered automatically when changes are pushed to `main` or `master` branches. No manual action is normally required.
63
+
64
+
#### Deploy script
65
+
66
+
If the GitHub action fails, after pushing changes, you can deploy using the script:
0 commit comments