This repo is part of the philu set of repos, that create the philanthropyu.org website

openedx-rg-plugin
#################

.. note::

  This README was auto-generated. Maintainer: please review its contents and
  update all relevant sections. Instructions to you are marked with
  "PLACEHOLDER" or "TODO". Update or remove those sections, and remove this
  note when you are done.

|pypi-badge| |ci-badge| |codecov-badge| |doc-badge| |pyversions-badge|
|license-badge| |status-badge|

Purpose
*******

RG Extentions for Open edX Platform
-----------------------------------

This plugin is designed to simplify the process of setting up and maintaining RG's Open Edx platform releases.

EdX Info Pages App
------------------

EdX Info Pages is a Django application designed to enhance the capabilities of OpenEdx LMS administrators.
It introduces an additional extra tab in the LMS admin panel ``Info Pages``, specifically for managing informational
pages, where staff members can create content in multiple languages.

Configuration

All of the plugin's settings are located in *edx_info_pages/settings/common.py*.
Please ensure that you set up MODELTRANSLATION_LANGUAGES. This should be a tuple of supported languages.

If not configured, the default language will be the platform's default language from LANGUAGE_CODE.

`MODELTRANSLATION_DEFAULT_LANGUAGE` specifies the default language for info page translation.
Its default value is `LANGUAGE_CODE`.

To modify the TinyMCE configuration, you can update `TINYMCE_DEFAULT_CONFIG`.

Getting Started
***************

Developing
==========

One Time Setup
--------------
.. code-block::

  # Clone the repository
  git clone [email protected]:openedx/openedx-rg-plugin.git
  cd openedx-rg-plugin

  # Set up a virtualenv using virtualenvwrapper with the same name as the repo and activate it
  mkvirtualenv -p python3.8 openedx-rg-plugin

  # After installing the plugin
  1. cd edx-platform
  1. paver update_db
  1. reload the platform
  1. run migrations


Every time you develop something in this repo
---------------------------------------------
.. code-block::

  # Activate the virtualenv
  workon openedx-rg-plugin

  # Grab the latest code
  git checkout main
  git pull

  # Install/update the dev requirements
  make requirements

  # Run the tests and quality checks (to verify the status before you make any changes)
  make validate

  # Make a new branch for your changes
  git checkout -b <your_github_username>/<short_description>

  # Using your favorite editor, edit the code to make your change.
  vim ...

  # Run your new tests
  pytest ./path/to/new/tests

  # Run all the tests and quality checks
  make validate

  # Commit all your changes
  git commit ...
  git push

  # Open a PR and ask for review.

Deploying
=========

TODO: How can a new user go about deploying this component? Is it just a few
commands? Is there a larger how-to that should be linked here?

PLACEHOLDER: For details on how to deploy this component, see the `deployment how-to`_

.. _deployment how-to: https://docs.openedx.org/projects/openedx-rg-plugin/how-tos/how-to-deploy-this-component.html

Getting Help
************

Documentation
=============

PLACEHOLDER: Start by going through `the documentation`_.  If you need more help see below.

.. _the documentation: https://docs.openedx.org/projects/openedx-rg-plugin

(TODO: `Set up documentation <https://openedx.atlassian.net/wiki/spaces/DOC/pages/21627535/Publish+Documentation+on+Read+the+Docs>`_)

More Help
=========

If you're having trouble, we have discussion forums at
https://discuss.openedx.org where you can connect with others in the
community.

Our real-time conversations are on Slack. You can request a `Slack
invitation`_, then join our `community Slack workspace`_.

For anything non-trivial, the best path is to open an issue in this
repository with as many details about the issue you are facing as you
can provide.

https://github.com/openedx/openedx-rg-plugin/issues

For more information about these options, see the `Getting Help`_ page.

.. _Slack invitation: https://openedx.org/slack
.. _community Slack workspace: https://openedx.slack.com/
.. _Getting Help: https://openedx.org/getting-help

License
*******

The code in this repository is licensed under the AGPL 3.0 unless
otherwise noted.

Please see `LICENSE.txt <LICENSE.txt>`_ for details.

Contributing
************

Contributions are very welcome.
Please read `How To Contribute <https://openedx.org/r/how-to-contribute>`_ for details.

This project is currently accepting all types of contributions, bug fixes,
security fixes, maintenance work, or new features.  However, please make sure
to have a discussion about your new feature idea with the maintainers prior to
beginning development to maximize the chances of your change being accepted.
You can start a conversation by creating a new issue on this repo summarizing
your idea.

The Open edX Code of Conduct
****************************

All community members are expected to follow the `Open edX Code of Conduct`_.

.. _Open edX Code of Conduct: https://openedx.org/code-of-conduct/

People
******

The assigned maintainers for this component and other project details may be
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
file in this repo.

.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/openedx-rg-plugin

Reporting Security Issues
*************************

Please do not report security issues in public. Please email [email protected].

.. |pypi-badge| image:: https://img.shields.io/pypi/v/openedx-rg-plugin.svg
    :target: https://pypi.python.org/pypi/openedx-rg-plugin/
    :alt: PyPI

.. |ci-badge| image:: https://github.com/openedx/openedx-rg-plugin/workflows/Python%20CI/badge.svg?branch=main
    :target: https://github.com/openedx/openedx-rg-plugin/actions
    :alt: CI

.. |codecov-badge| image:: https://codecov.io/github/openedx/openedx-rg-plugin/coverage.svg?branch=main
    :target: https://codecov.io/github/openedx/openedx-rg-plugin?branch=main
    :alt: Codecov

.. |doc-badge| image:: https://readthedocs.org/projects/openedx-rg-plugin/badge/?version=latest
    :target: https://openedx-rg-plugin.readthedocs.io/en/latest/
    :alt: Documentation

.. |pyversions-badge| image:: https://img.shields.io/pypi/pyversions/openedx-rg-plugin.svg
    :target: https://pypi.python.org/pypi/openedx-rg-plugin/
    :alt: Supported Python versions

.. |license-badge| image:: https://img.shields.io/github/license/openedx/openedx-rg-plugin.svg
    :target: https://github.com/openedx/openedx-rg-plugin/blob/main/LICENSE.txt
    :alt: License

.. TODO: Choose one of the statuses below and remove the other status-badge lines.
.. |status-badge| image:: https://img.shields.io/badge/Status-Experimental-yellow
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Deprecated-orange
.. .. |status-badge| image:: https://img.shields.io/badge/Status-Unsupported-red