docs(lms and studio): Replace all .(lms|cms).(\w+|_)?\.json to .(lms|cms).(\w+|_)?\.yml

This commit is contained in:
Gábor Boros
2020-09-18 10:44:14 +02:00
parent 8f3393d96c
commit 6ccd6c308d
5 changed files with 10 additions and 10 deletions

View File

@@ -367,7 +367,7 @@ class OAuth2ProviderConfig(ProviderConfig):
u'For increased security, you can avoid storing this in your database by leaving '
' this field blank and setting '
'SOCIAL_AUTH_OAUTH_SECRETS = {"(backend name)": "secret", ...} '
'in your instance\'s Django settings (or lms.auth.json)'
'in your instance\'s Django settings (or lms.yml)'
)
)
other_settings = models.TextField(blank=True, help_text=u"Optional JSON object with advanced settings, if any.")
@@ -431,7 +431,7 @@ class SAMLConfiguration(ConfigurationModel):
'Paste the contents of saml.key here. '
'For increased security, you can avoid storing this in your database by leaving '
'this field blank and setting it via the SOCIAL_AUTH_SAML_SP_PRIVATE_KEY setting '
'in your instance\'s Django settings (or lms.auth.json).'
'in your instance\'s Django settings (or lms.yml).'
),
blank=True,
)
@@ -440,7 +440,7 @@ class SAMLConfiguration(ConfigurationModel):
u'Public key certificate. '
'For increased security, you can avoid storing this in your database by leaving '
'this field blank and setting it via the SOCIAL_AUTH_SAML_SP_PUBLIC_CERT setting '
'in your instance\'s Django settings (or lms.auth.json).'
'in your instance\'s Django settings (or lms.yml).'
),
blank=True,
)
@@ -879,7 +879,7 @@ class LTIProviderConfig(ProviderConfig):
'For increased security, you can avoid storing this in '
'your database by leaving this field blank and setting '
'SOCIAL_AUTH_LTI_CONSUMER_SECRETS = {"consumer key": "secret", ...} '
'in your instance\'s Django setttigs (or lms.auth.json)'
'in your instance\'s Django setttigs (or lms.yml)'
),
blank=True,
)

View File

@@ -74,8 +74,8 @@ mechanism:
``openedx.core.djangoapps.theming.finders.ThemeFilesFinder``
Custom finder that overrides any static asset with a version from the themes
directory (``COMPREHENSIVE_THEME_DIRS`` defined in ``lms.envs.json`` and
``cms.envs.json``).
directory (``COMPREHENSIVE_THEME_DIRS`` defined in ``lms.yml`` and
``studio.yml``).
``openedx.core.lib.xblock_pipeline.finder.XBlockPipelineFinder``
Custom finder that accesses and extracts assets from pip-installed XBlocks via

View File

@@ -454,7 +454,7 @@ def _footer_logo_img(is_secure):
logo_name = configuration_helpers.get_value('FOOTER_ORGANIZATION_IMAGE', settings.FOOTER_ORGANIZATION_IMAGE)
# `logo_name` is looked up from the configuration,
# which falls back on the Django settings, which loads it from
# `lms.env.json`, which is created and managed by Ansible. Because of
# `lms.yml`, which is created and managed by Ansible. Because of
# this runaround, we lose a lot of the flexibility that Django's
# staticfiles system provides, and we end up having to hardcode the path
# to the footer logo rather than use the comprehensive theming system.

View File

@@ -3705,7 +3705,7 @@ FINANCIAL_ASSISTANCE_MAX_LENGTH = 2500
# IE: custom_form_app.forms.RegistrationExtensionForm
# Note: If you want to use a model to store the results of the form, you will
# need to add the model's app to the ADDL_INSTALLED_APPS array in your
# lms.env.json file.
# lms.yml file.
REGISTRATION_EXTENSION_FORM = None

View File

@@ -103,7 +103,7 @@ directory. There are two ways to do this.
$ sudo /edx/bin/update configuration master
$ sudo /edx/bin/update edx-platform HEAD
#. Otherwise, edit the /edx/app/edxapp/lms.env.json file to add the
#. Otherwise, edit the /edx/app/edxapp/lms.yml file to add the
``COMPREHENSIVE_THEME_DIRS`` value::
"COMPREHENSIVE_THEME_DIRS": ["/full/path/to/my-theme"],
@@ -180,7 +180,7 @@ In addition, there are some other changes you'll need to make:
config value in your site configuration.
* You can set the google site verification ID in the GOOGLE_SITE_VERIFICATION_ID
in your site configuration. Otherwise, edit the /edx/app/edxapp/lms.env.json
in your site configuration. Otherwise, edit the /edx/app/edxapp/lms.yml
file to set the value for GOOGLE_SITE_VERIFICATION_ID. Setting the value for
GOOGLE_SITE_VERIFICATION_ID will add the meta tag for google site verification
in the lms/templates/main.html which is the main Mako template that all page