Skip to content

Commit

Permalink
docs: add info about tutor-contrib-wordpress plugin (#84)
Browse files Browse the repository at this point in the history
* docs: tutor related info added

With the help of tutor-contrib-wordpress plugin, there's no need create oauth application and users. it will take care of those steps.

* docs: trailing whitespace removed

* docs: phpcs.xml file reformatted
  • Loading branch information
CodeWithEmad authored Oct 29, 2024
1 parent 7264c36 commit 5429bff
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 12 deletions.
8 changes: 7 additions & 1 deletion docs/source/how-tos/create_an_openedx_app.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ Create an Open edX Application for the Plugin Settings

You will learn how to create an Open edX Application for filling out the form in the Open edX Sync Plugin Settings in our WordPress Settings.

If you are using `Tutor`_ for managing your Open edX instance, you can install `tutor-contrib-wordpress`_ and use its commands assist with the
configuration and integration of the Open edX platform with an existing WordPress site.

Index
-------
- `Requisites`_
Expand Down Expand Up @@ -34,11 +37,14 @@ Create an Open edX Application to Configure the Open edX Commerce plugin
.. image:: /_images/how-tos/create_an_openedx_app/openedx-sync-plugin-settings.png
:alt: Open edX Sync Plugin Settings

#. Test the credentials by clicking **Save Changes** and **Generate JWT Token**.
#. Test the credentials by clicking **Save Changes** and **Generate JWT Token**.

.. note:: If you do not have credentials to enter the Django Admin, you need to contact an operator of your Open edX instance to provide you the **client id and client secret of an Application** with **Client Credentials** as **Authorization grant type** and **staff user**.

Next Steps
-----------

- :doc:`How-to: Create enrollment requests manually </how-tos/create_enrollment_requests_manually>`.

.. _Tutor: https://docs.tutor.edly.io
.. _tutor-contrib-wordpress: https://github.com/CodeWithEmad/tutor-contrib-wordpress
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ User Guide
tutorials/index
how-tos/index
decisions/index



Open edX Compatibility
Expand Down
20 changes: 10 additions & 10 deletions phpcs.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,31 +10,31 @@
<exclude-pattern>index.php</exclude-pattern>
<exclude-pattern>composer-setup.php</exclude-pattern>

<arg value="sp"/>
<arg name="basepath" value="./"/>
<arg name="colors"/>
<arg name="extensions" value="php"/>
<arg name="parallel" value="8"/>
<arg value="sp" />
<arg name="basepath" value="./" />
<arg name="colors" />
<arg name="extensions" value="php" />
<arg name="parallel" value="8" />

<rule ref="WordPress">
</rule>
<rule ref="WordPress.NamingConventions.PrefixAllGlobals">
<properties>
<property name="prefixes" type="array" value="openedx_commerce" />
</properties>
<properties>
<property name="prefixes" type="array" value="openedx_commerce" />
</properties>
</rule>

<rule ref="WordPress.WP.I18n">
<properties>
<property name="text_domain" type="array">
<element value="openedx-commerce"/>
<element value="openedx-commerce" />
</property>
</properties>
</rule>

<rule ref="Generic.Files.LineEndings">
<properties>
<property name="eolChar" value="\n"/>
<property name="eolChar" value="\n" />
</properties>
</rule>

Expand Down

0 comments on commit 5429bff

Please sign in to comment.