Commit Graph

1331 Commits

Author SHA1 Message Date
Feanil Patel
8c43868b52 docs: Rename swagger.yaml to lms-openapi.yaml
* Swagger was renamed to OpenAPI at some point so use the new name for
  clarity.

* Prefix with `lms` to make it clear that these are the APIs from the
  LMS and may not all be available in the CMS.
2023-06-29 15:37:10 -04:00
Feanil Patel
26262131ae docs: Remove the api docs sphinx project.
* This project was not being published anywhere.
* The previous commit that adds openapi generation capabilities to the
  `docs/guides` replaces what this was doing.
2023-06-29 15:37:10 -04:00
Feanil Patel
56cad59e97 docs: Generate rst from the existing swagger docs.
Use an existing 3rd party library to generate RST docs from the existing
swagger.yaml file.
2023-06-29 15:37:10 -04:00
Kyle McCormick
478c301df5 docs: improve filters & events links in Hooks guide (#32588)
* point to upstream repos, not eduNEXT forks
* link to guides, not just source repos
* fix spelling of Open edX
2023-06-27 19:10:54 +00:00
Ned Batchelder
8e7b0c1c73 fix: oscm@edx.org is not the right email for asking about APIs
We get about one email per month from people looking for access to edX
APIs.  Those emails come to the now almost-defunct oscm@edx.org email
address.  I think that's because of these swagger references.

I suppose someone could find this email address on an Open edX
installation, and people would write to it, but I find in practice this
doesn't happen.

Co-authored-by: Kyle McCormick <kyle@tcril.org>
2023-05-22 07:51:45 -07:00
Kshitij Sobti
1c3c702583 chore: Switch from edx-sphinx-theme to sphinx-book-theme
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme.
This removes references to the deprecated theme and replaces them with the new
standard theme for the platform.

See https://github.com/openedx/edx-sphinx-theme/issues/184
2023-04-28 09:16:09 +05:30
Kyle McCormick
6b2d3fb807 docs: downgrade settings ADR status to "Provisional" (#32113)
The ideas here are good and in line with OEP-45, but we have not
yet had a chance to implement them in edx-platform

Furthermore, recent conversations have made us consider
revisiting the "Don't use YAML files, just python modules"
alternative described in the ADR. Particularly, Tutor has
not been able to use pure YAML to configure edx-platform,
and has fallen back on having separate .py settings files.
This makes us think that we either need to expose
more power through the YAML interface, or we need to
re-embrace .py settings files.
2023-04-21 10:25:10 -04:00
Felipe Montoya
f4bb83b22b fix: typo in the documentation for hooks that prevented the rst rendering (#31984) 2023-03-24 15:08:00 -04:00
Kyle McCormick
463b64d349 docs: tweak webpack config design in assets ADR (#31949)
Follow-up from:
https://github.com/openedx/edx-platform/pull/31790#discussion_r1110202654

Part of DEPR:
https://github.com/openedx/edx-platform/issues/31895
2023-03-16 16:25:23 -04:00
Tim McCormack
d48c42d4c5 chore: Update rST header styles in one file to match our doc guidelines (#260)
(This is also serving as a test of the security patch process.)
2023-03-13 13:51:21 +00:00
Rebecca Graber
918e822eda docs: add need for browser container for JS tests (#31911) 2023-03-13 08:03:27 -04:00
Kyle McCormick
2ca95e5213 docs: add ADR to reimplement static asset processing (#31790) 2023-03-10 08:08:05 -05:00
Rebecca Graber
fbbc2cea50 docs: clarify intent of ADR-14 (#31863) 2023-03-03 15:53:28 -05:00
ALi Raza
0ff7c5b13f feat: Enable Certificate Display Behavior add certificate_available_date in course detail API
feat: Enable Certificate Display Behavior add certificate_available_date in course detail API

fix: reviwed changes, certificate_available_date in Course Detail API but not in Course List API

fix: reviewed changes, certificate available date display condition updated

fix: final reviewed changes

fix: serializer and linting tests

fix: serializer and tests

fix: docstring

fix: docstring and tests

fix: typo and mock call
2023-02-23 22:34:11 +05:00
Arunmozhi
2b59265240 feat: adds VerticalBlockRenderCompleted filter hook (#31388)
* feat: adds VerticalBlockChildrenLoaded filter call

This introduces the VerticalBlockChildrenLoaded filter that is run after
all the child blocks are fetched before rendering a student or the
public view. This will allow modifying the contents of the VerticalBlock
before presenting it to the students.
2023-02-22 15:05:19 -04:00
Tim McCormack
197fef9c2b docs: Various cleanup of outdated comments and docstrings (#31754)
- Remove pylint warning suppression from SHAKE-128 hexdigest calls; these
  are no longer needed as of astroid 2.12.12. For background, see issue
  <https://github.com/PyCQA/pylint/issues/4039>. Also, correct a comment
  that referred to SHAKE-256 instead of SHAKE-128.
- Replace "released" with "beta" in several places where there was a copy
  & paste error in dark_lang. Add mention of `beta_lang` to a docstring
  where it was omitted.
- Remove comment regarding Mongo startup; the code it referred to has since
  been removed.
- Fix typos.
2023-02-14 18:11:57 +00:00
Navin Karkera
4697adc681 feat: hook xblock publish, delete and duplicate openedx-events (#31350) 2023-02-14 19:25:30 +05:00
Diana Huang
4afe0c92f2 docs: Add course catalog info changed event to docs. (#31732)
https://github.com/edx/edx-arch-experiments/issues/178
2023-02-09 12:28:30 -05:00
AsadAzam
255cb73070 docs: adr to add new notifications application (#31655)
* docs: adr to add new notifications application

* docs: accepted adr
2023-02-02 12:27:58 +05:00
0x29a
9d8375ff99 refactor: rename module -> block within lms/djangoapps/courseware
Also, removed unused `_has_access_xmodule` methid from `lms/djangoapps/courseware/access.py`.
2023-01-30 18:15:22 +01:00
Zubair Shakoor
141d6d4ce6 refactor: remove all paver code related to python unit tests (#31180) 2023-01-18 17:41:56 +05:00
0x29a
4c005e86e8 refactor: xmodule/capa_module.py -> xmodule/capa_block.py 2022-12-19 17:48:49 +01:00
Navin Karkera
c302c8a22b feat: block metadata api - index_dictionary
Adds new api to return block metadata which includes index_dictionary.
Reason for new api instead of adding it to course blocks API: data like
index_dictionary are too large for the cache used by course/blocks
transformers API.
2022-11-29 10:49:36 -08:00
UsamaSadiq
897cb3617f refactor!: delete common/lib and related usages 2022-09-22 14:16:34 +05:00
Sarina Canelake
4a2f231302 fix: fix github url strings (org edx -> openedx) 2022-09-15 14:52:28 -04:00
Sagirov Evgeniy
42adcaaf4d FC-0001: Remove Persistent Course Grades Flags (#30978)
* feat: revert Fix certificate generation without persistent grades

* feat: Remove Persistent Course Grades Flags

* test: update tests
2022-09-14 14:00:01 -04:00
Arunmozhi
6867d55364 feat: adds openedx-filter hook to the child blocks of VerticalBlock
This commit adds a openedx-filters hook to the VerticalBlock XBlock
before rendering of it's children. This allows Open edX plugins to
customize the presentation of specific blocks based on the context.
2022-08-20 13:09:10 +05:30
Muhammad Soban Javed
d053bba952 Revert "Revert "refactor: move common/lib/capa/capa to xmodule/capa" (#30762)"
This reverts commit 4463ee751d.
2022-07-27 15:36:08 +05:00
Kyle McCormick
423acd32f9 docs: retroactively add ADR for dissolution of sub-projects (#30779) 2022-07-26 11:33:01 -04:00
Muhammad Soban Javed
4463ee751d Revert "refactor: move common/lib/capa/capa to xmodule/capa" (#30762) 2022-07-21 18:22:15 +05:00
Soban Javed
9eba9f983a refactor!: move common/lib/capa/capa to xmodule/capa
As part of dissolving our sub-projects in edx-platform, we are moving this package under the xmodule directory.
We have fixed all the occurences of import of this package and also fixed all documents related references.
This might break your platform if you have any reference of `import capa` or `from capa import` in your codebase or in any Xblock.

Ref: https://openedx.atlassian.net/browse/BOM-2582
2022-07-19 12:20:04 +05:00
Maria Grimaldi
033934e896 docs: add Open edX Events & Filters latest documentation 2022-06-22 09:13:13 -04:00
Muhammad Umar Khan
a389a9ff10 Revert "Revert "refactor: move xmodule folder to root"" 2022-06-20 18:20:06 +05:00
Muhammad Umar Khan
d890f06507 Revert "refactor: move xmodule folder to root" 2022-06-20 16:03:48 +05:00
M Umar Khan
a91df0c40f refactor: move xmodule folder to root
- Moving xmodule folder to root as we're dissolving sub-projects of common folder in edx-platform
    - More info: https://openedx.atlassian.net/browse/BOM-2579
- -e common/lib/xmodule has been removed from the requirements as xmodule has itself become the part of edx-platform and not being installed through requirements
- The test files common/lib/xmodule/test_files/ have been removed as they are not being used anymore
2022-06-20 14:33:45 +05:00
Rebecca Graber
05b4aa8d4b docs: ADR with guidance for new applications (#30053) 2022-06-06 11:36:27 -04:00
Saksham Agrawal
e6caca26c2 docs: ADR for library reference content block (#29633) 2022-05-31 10:49:53 -04:00
Kyle McCormick
25df9ca420 refactor: make safe_lxml an ordinary folder in openedx/core/lib (#25689) 2022-05-24 15:35:23 +05:00
Feanil Patel
f2ec7b5053 chore: Cleanup last remenants of the edx-microsite code. (#30306)
There are still references to the word `microsite` because the
site-configuration code uses it to referr to it's sub-sites in a few
places.
2022-04-25 10:48:35 -04:00
Michael Terry
bc10f653dc fix: remove a couple unused learning MFE serializer fields
Now that the frontend assumes there are no legacy courseware pages,
we can stop sending them info about it.
2022-04-19 15:06:37 -04:00
Michael Terry
afd19f0513 feat!: drop legacy courseware tab access for learners
The only way to access the legacy courseware is now through the
Studio preview feature (and at some point, when the MFE supports a
preview mode, we can then remove even that).

This drops the courseware.use_legacy_frontend waffle.
2022-04-19 12:27:10 -04:00
Feanil Patel
e35c7e278b build: Simplify how we build docs.
Instead of trying to use the devstack settings file for building docs,
use the common settings file as the base for all settings.  The
devstack settings file builds on top of the production settings file
which are both oriented around reading settings from a yaml file and
getting them loaded in sanely into the dev and production environment.

For documentation, start with the common settings files which should be
sufficient to get a default version of the system up and running.

Note: We still leave the loop that enables all the feature flags as a way
of finding conditionally included API endpoints.
2022-03-25 10:08:21 -04:00
Awais Qureshi
856731fd48 docs: Removing bokchoy and a11y reference from documentation. (#30105)
* docs: Removing bokchoy and a11y reference from documentation.
2022-03-24 18:26:43 +05:00
Chris Deery
e8462bb667 feat: [AA-1207] remove redundant Tabs fields from courseware API (#30079)
feat: [AA-1207] remove redundant Tabs fields from courseware API

Remove redundant fields from courseware API.

- number
- verified_mode
- original_User_is_staff
- is_staff

This is the backend work for https://github.com/openedx/frontend-app-learning/pull/873
2022-03-18 12:09:52 -04:00
Chris Deery
50f348b395 feat: [AA-1207] remove redundant Tabs fields from courseware API (#30023)
* feat: [AA-1207] remove redundant Tabs fields from courseware API

All the tab information now goes through the course home metadata tab fields. This field is redundant.
2022-03-11 09:36:28 -05:00
Chris Deery
b61b29196b feat: [AA-1206] remove redundant fields from API (#29920)
* feat: [AA-1206] remove redundant fields from API

Part of a larger effort to clean up the MFE BFF endpoints.
Remove the redundant fields username and course_access, both of which are also available in the course home metadata call.
2022-03-04 09:01:02 -05:00
Carlos Muniz
8e8d8404be Carlos muniz/symmath removal unrevert (#29912)
* Revert "Merge pull request #29909 from openedx/revert-29869-Carlos-Muniz/symmath-removal"

This reverts commit 8c0db8ddff, reversing
changes made to 1156c62014.

* fix: Remove misplaced `-e`

`-e` was wrongfully placed in front of `common/lib/sandbox-packages`,
which may have most likely been causing the edxAPP to break.

* fix: Change regex to apply to right dirs

`py38.txt` does not include `common/lib/xmodule` so it doesn't match the
regex. Therefore, it never got its lines in `common/lib/sandbox-packages`
fixed. If we change the regex to match any `common/lib/<packagename>` it
should work correctly.
2022-02-14 10:26:40 -05:00
Phillip Shiu
6ac1dd688a Revert "Remove symmath from edx-platform" 2022-02-11 10:30:08 -05:00
Carlos Muniz
b80d8d6030 refactor: Remove all mentions of symmath 2022-02-10 14:55:22 -05:00
Kyle McCormick
51fccf06d1 docs: add ADR to declare distinction between 'cms' and 'studio' 2022-01-04 15:07:04 -05:00