docs: improve documentation to explain the actual plugin behavior #105
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mariajgrimaldi
requested changes
Jun 12, 2024
dcoa
changed the title
mariajgrimaldi
approved these changes
Jun 25, 2024
README.rst
Outdated
|
|
||
| .. code-block:: bash | ||
| #. Install a new fresh instance of tutor following `this steps <https://docs.tutor.overhang.io/quickstart.html#quickstart-1-click-install>`_. *If your instance is running, you can skip this step.* | ||
| #. Add to the Tutor configuration in the file ``cat "$(tutor config printroot)/config.yml"`` these lines that install eox-tagging lib: |
There was a problem hiding this comment.
Let's use the same structure as in eox-tenant:
#. Add this plugin in your Tutor ``config.yml`` with the ``OPENEDX_EXTRA_PIP_REQUIREMENTS`` setting.
.. code-block:: yaml
OPENEDX_EXTRA_PIP_REQUIREMENTS:
- eox-tagging=={{version}}
#. Save the configuration with ``tutor config save``.
#. Build the image and launch your platform with ``tutor local launch``.
README.rst
Outdated
Comment on lines
54
to
59
| The plugin is configured for the latest release (Quince). | ||
|
|
||
| We will list here the changes in the plugin settings that should be applied to be used for previous releases. If the release you are looking for is not listed, | ||
| the actual configuration is sufficient or incompatible with the current eox-tagging version. | ||
|
|
||
| If you are installing a previous version, please refer to the tag to verify the configuration that should be applied. |
There was a problem hiding this comment.
Same here:
Suggested change
| The plugin is configured for the latest release (Quince). | |
| We will list here the changes in the plugin settings that should be applied to be used for previous releases. If the release you are looking for is not listed, | |
| the actual configuration is sufficient or incompatible with the current eox-tagging version. | |
| If you are installing a previous version, please refer to the tag to verify the configuration that should be applied. | |
| The plugin is configured for the latest release (Quince). The following changes in the plugin settings should be applied to be used for previous releases. | |
| If the release you are looking for is not listed, the actual configuration is sufficient or it is incompatible with the current eox-tagging version. |
|
Just a few comments left to address. If my review is erased by a new commit (not sure if that's the configuration for this repo) please ping me so I can approve again. |
magajh
requested changes
Jun 26, 2024
magajh
reviewed
Jun 26, 2024
magajh
requested changes
Jun 26, 2024
Co-authored-by: Mariagabriela Jaimes <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the repository documentation for a better understanding of the eox-tagging plugin.
For repo description:
Additional information
JIRA