Skip to content

Commit 3f1845a

Browse files
authored
docs: add automatic installation info and change github docs links to rtd docs (#108)
1 parent 0f3bb94 commit 3f1845a

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here are some things you can do with this plugin:
2727

2828
This plugin calls the APIs from <a href="https://github.com/openedx/edx-platform" target="_blank">Open edX Platform</a>.
2929

30-
More information about the API connection can be found in <a href="https://github.com/openedx/openedx-wordpress-ecommerce/blob/main/docs/source/decisions/0002-api-connection.rst" target="_blank">Decisions: API connection</a>.
30+
More information about the API connection can be found in <a href="https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/decisions/0002-api-connection.html" target="_blank">Decisions: API connection</a>.
3131

3232
To learn more, you can visit the <a href="https://openedx.org/terms-of-use/" target="_blank">Open edX Terms of Service</a>.
3333

@@ -39,6 +39,12 @@ To learn more, you can visit the <a href="https://openedx.org/terms-of-use/" tar
3939
- Wordpress 6.3.1
4040
- [WooCommerce plugin.](https://wordpress.org/plugins/woocommerce)
4141

42+
## Automatic installation
43+
44+
To automatically install Open edX Commerce, log in to your WordPress dashboard. Then, navigate to the Plugins menu and click on "Add New."
45+
46+
In the search field, type "Open edX Commerce" and click "Search Plugins." Once you find the plugin, you can view its details and install it by clicking "Install Now." WordPress will handle the rest of the installation process for you.
47+
4248
## Manual installation
4349

4450
1. Download the ZIP version on [the release page in the GitHub repository](https://github.com/openedx/openedx-wordpress-ecommerce/releases).
@@ -60,7 +66,7 @@ In the search field, type "Open edX WooCommerce Plugin," then click "Search Plug
6066

6167
Let's start installing and configuring the Open edx Commerce plugin to connect your WordPress site with the enrollment APIs from your Open edX platform.
6268

63-
[Link to the Quickstart in the documentation.](https://github.com/openedx/openedx-wordpress-ecommerce/blob/main/docs/source/plugin_quickstart.rst)
69+
[Link to the Quickstart in the documentation.](https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html)
6470

6571

6672
# Open edX Compatibility

README.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Below are some links to help you get started with Open edX WooCommerce Plugin:
4545

4646
This plugin calls the APIs from <a href="https://github.com/openedx/edx-platform" target="_blank">Open edX Platform</a>.
4747

48-
More information about the API connection can be found in <a href="https://github.com/openedx/openedx-wordpress-ecommerce/blob/main/docs/source/decisions/0002-api-connection.rst" target="_blank">Decisions: API connection</a>.
48+
More information about the API connection can be found in <a href="https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/decisions/0002-api-connection.html" target="_blank">Decisions: API connection</a>.
4949

5050
To learn more, you can visit the <a href="https://openedx.org/terms-of-use/" target="_blank">Open edX Terms of Service</a>.
5151

@@ -59,6 +59,12 @@ This plugin is maintained by <a href="https://edunext.co/" target="_blank">edune
5959
* Wordpress 6.3
6060
* [WooCommerce plugin](https://wordpress.org/plugins/woocommerce)
6161

62+
= Automatic installation =
63+
64+
To automatically install Open edX Commerce, log in to your WordPress dashboard. Then, navigate to the Plugins menu and click on "Add New."
65+
66+
In the search field, type "Open edX Commerce" and click "Search Plugins." Once you find the plugin, you can view its details and install it by clicking "Install Now." WordPress will handle the rest of the installation process for you.
67+
6268
= Manual installation =
6369

6470
1. Download the ZIP version on [the release page in the GitHub repository](https://github.com/openedx/openedx-wordpress-ecommerce/releases).
@@ -75,7 +81,7 @@ This plugin is maintained by <a href="https://edunext.co/" target="_blank">edune
7581

7682
Let's start installing and configuring the Open edx Commerce plugin to connect your WordPress site with the enrollment APIs from your Open edX platform.
7783

78-
[Link to the Quickstart in the documentation.](https://github.com/openedx/openedx-wordpress-ecommerce/blob/main/docs/source/plugin_quickstart.rst)
84+
[Link to the Quickstart in the documentation.](https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html)
7985

8086
== Frequently Asked Questions ==
8187

docs/source/plugin_quickstart.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,13 @@ Requirements
2424
- Wordpress 6.3.1 or greater
2525
- `WooCommerce plugin. <https://wordpress.org/plugins/woocommerce>`_
2626

27+
Automatic installation
28+
^^^^^^^^^^^^^^^^^^^^^^^
29+
30+
To automatically install Open edX Commerce, log in to your WordPress dashboard. Then, navigate to the Plugins menu and click on "Add New."
31+
32+
In the search field, type "Open edX Commerce" and click "Search Plugins." Once you find the plugin, you can view its details and install it by clicking "Install Now." WordPress will handle the rest of the installation process for you.
33+
2734
Manual Installation
2835
^^^^^^^^^^^^^^^^^^^^
2936

0 commit comments

Comments
 (0)