openedx / edx-documentation Goto Github PK

Publishing translations for the latest named release should not break translations for previous named releases.

Sphinx has undergone a pretty significant upgrade. Docs are going to produce more warnings and this will require a non-trivial amount of effort.

• We should use tooling to ensure that we don't have to re-translate items that have already been translated previously.
  • Transifex translation memory(TM) might be useful for this, especially with TM Groups.
  • We can push up translations when we setup a new project. Maybe we can push the previous named release's translations as a starting point.

Big Blue Button Installation doc links are out of date:

Looks like they could be updated to: https://docs.bigbluebutton.org/administration/install
https://docs.bigbluebutton.org/administration/lti

There are RST files in the edx-documentation repo that don't seem to be published anywhere.

Stakeholders: Marco Morales, Jennifer Akana, Ben Piscopo, @nedbat

AC:

• Any unused RST files in the edx-documentation repo have been removed.

Probably not correct repository but failed to find if blogs are within git anywhere

on
https://open.edx.org/blog/newest-open-edx-release-dogwood-now-available
Installation Guide points to http://edx.readthedocs.org/projects/open-edx-icr/en/named-release-dogwood.rc/ which is non-existent

it's not clear from the instruction on page

https://github.com/edx/edx-documentation/blob/master/en_us/shared/exercises_tools/peer_instruction_tool.rst

that Peer Instruction, if using the Open Edx version (not the partner edX version), needs to be installed as X-Block before being able to enable it in Settings/Adv. Settings. Could be improved in the documentation.

Investigating a security issue on a bank's site led me to this project. The password policy defined in lms.yml configuration file appears to cause numerous productive systems to allow for passwords of length 2. This is because developers apparently miss to override the min_length: 2 validator option in production.

See also password.rst:

AUTH_PASSWORD_VALIDATORS:
-   NAME: django.contrib.auth.password_validation.UserAttributeSimilarityValidator
-   NAME: common.djangoapps.util.password_policy_validators.MinimumLengthValidator
      OPTIONS:
        min_length: 2

Although it is not really the responsibility of this project, I suggest this value to be changed to conform to latest password policy recommendations. For example, regarding password length NIST says minimum of 8. Microsoft says minimum of 12. OWASP says minimum of 8, in some places.

All processes for creating translations should be documented.

I've just installed & run openedx successfull, it's still runing now.
I've a small trouble in how to check user login & time of login for each users (like students), time per day...

Thanks for support!.

This is not solely a documentation issue, but it affects the documentation, and we were unable to come up with a better place to log this issue.

The documentation for the Periodic Table Tool instructs users to download a file from files.edx.org. The link to this is http, rather than https.

The file in question is a zip file containing 4 files:

The HTML in this file checks Files & Uploads for the two CSS and one JS file in the download, but it checks for periodic-table-colors.css and the file is named Periodic-Table-Colors.css - it's case sensitive.

This means that the tool does not actually function by following the documentation, because the files provided are named incorrectly.

Proposed solutions:

1. Remove the periodic table tool from the documentation. It's not really a feature anyway.
2. Update the files and host them somewhere else so that they can be maintained (such as this repository?)
3. Someone on the edX.org end fixes the files and reuploads them

Your issue content here.
edx upgrade notification is a real nag-drag - coming up for me in between EVERY segment of a few minutes long. How to stop it?

For example, I was trying to understand better how to build a circuit simulation problem (in my hawthorn installation), and so I copy/pasted the problem at the end of the page here into my course. It won't allow me to save it. I deleted references to files that I don't have in my course, but that made no difference. Then I wondered if it was a release issue, and so I searched specifically for Hawthorn Circuit Schematic Builder problem, and found this page. I tried the example there, and it worked just fine. Then I looked closely and found that if I read the URL carefully, I can tell the original docs were from Birch. Fortunately the new docs have Hawthorn called out prominently. :-)

Thanks for all your good work on these documents!
Rob

Your app contains an Implicit PendingIntent vulnerability. Please see this Google Help Center article for details.

i am unable to find issue in Edx code

I have encountered this problem too, Unable to load course openedx ios, spinning endlessly on viewing html block, and found the commit, but confused by the last update EdX Release Notice: This PR has been rolled back from the production environment.. I also can't find the referred issue LEARNER-3552 in the JIRA issue LIST, so the docs Setting Up the Open edX Mobile Applications is outdated for Ironwood release?

#2065 seems to have stalled so close it if that makes sense.

• Weekly upgrades are happening and notifying the correct people.

ID of every user in edX is set automatically (with a new number from last users we have, as a primary key)
For example,
ID User
1 userA
2 userB
3 userC

But, Microsoft (for example Academy.microsoft.com) use this ID for different activities (for example certificates)

For example, userB has finished lot of courses, but its id (2) is problematic. How can it be changed to a new ID? renaming previous user and creating a new one is not an option, because new user has not all his/her courses.

Is it possible? Changing directly in MySQL will affect information in Mongo, so it doesn't appear to be an option.
For example
ID User
888 UserB

We are Microsoft's partner, with an edX portal and we've got trouble with this elements.
Thanks and regards
Julio

I need documentation to setup CAS. https://github.com/edx/configuration/wiki/Setting-Up-External-Authentication is not helpful.

Thank you very much!

The documentation suggests that there is a possibility to construct "hinted links" that will allow a user to log in via a Third Party and land on course pages. However, this feature appears to have been broken for quite a while as discussed in the following forum topics:

• https://discuss.openedx.org/t/whats-the-deal-with-tpa-hinted-links-in-nutmeg-olive/8436
• https://discuss.openedx.org/t/tpa-hinted-links-with-the-learning-mfe/12427

At the moment the documentation still gives examples to the legacy LMS and does not mention if this feature will be or was never meant to work with the Learning MFE.

when i want to install edx i see the following error in make dev.provision step
please help me.

This is an epic with the task of adding product language to DEPR tickets. The immediate goal is to improve the Olive Release Notes with more comprehensive descriptions and context for DEPR work. The longer term goal is to set the DEPR Board up for product prioritization input and guidance.

Add "IDA" to Glossary.

IDA stands for "Independently Deployed Application".

See https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/style_guides/python-guidelines.html#pylint-guidelines-and-practices:

Adding a TODO in one place requires you to make a pylint fix in another (just to force us to clean up more code).

Please state explicitly whether "TODO" or "FIXME" is discourage and offer a viable alternative for flagging technical debt in the codebase when it cannot be addressed immediately due to time and scope constraints.

http://edx.readthedocs.org/projects/devdata/en/latest/glossary.html#c (for content experiment) points to http://edx.readthedocs.org/projects/edx-partner-course-staff/en/latest/content_experiments/index.html which is a bad link.

Aside from that, it really ought to have a pointer to:
http://edx.readthedocs.org/projects/devdata/en/latest/internal_data_formats/sql_schema.html#columns-in-the-user-api-usercoursetag-table

A common question a researcher might ask is "How do I analyze randomized control trials?" That's not possible to figure out without reading through basically all the docs.

https://edx.readthedocs.io/projects/edx-developer-guide/en/latest/extending_platform/index.html hasn't been updated since 2014 and contains lots of out-of-date information. It is also missing any information about plugins, MFEs, etc. that have been developed since.

Check to see if https://gitlab.com/documatt/sphinx-reredirects/-/merge_requests/10 has merged and been released, if not, give it another nudge and bump this ticket out a few sprints.

Once https://gitlab.com/documatt/sphinx-reredirects/-/merge_requests/10 has merged, we can turn on parallel builds again in run_tests.sh.

See cf90b90 for a more detailed explanation.

I just noticed the change log included November change at the top of October list, FYI:

http://edx-open-learning-xml.readthedocs.org/en/latest/change_log.html

I would have linked to something other than "latest" - if there were a tag to link to! --- so maybe that's a second issue...

If the documentation changes, the work towards i18n becomes obsolete. If versions of the documentation are maintained, then the Transifex Working group can focus on translating a version of the documentation without losing their progress.

الأدب العالمي مفاهيم ومصطلحات.pdf
Your issue content here.

If you don't create xblock_development/var the command

python xblock-sdk/manage.py migrate

will fail.

I found this solution by François Bouchet here...

https://groups.google.com/forum/#!searchin/edx-code/python$20xblock-sdk$2Fmanage.py$20migrate%7Csort:date/edx-code/PAru0A1k3No/IfFXAu80AQAJ

The IMS LTI 1.1 Consumer Launch link, on the Third Party auth setup page is broken.
It linked to a LTI test tool that now is closed/discontinued: http://www.imsglobal.org/developers/LTI/test/v1p1/lms.php

I found a similar tool that does the same, but the test instructions on that page need to be updated: http://www.ltiapps.net/test/tc.php

https://developers.google.com/webmasters/state-of-the-web/2005/classes?csw=1

When a new named release is created, a translation project should be created for it.

https://drive.google.com/file/d/1VR1MfnlEWNKaTmKvgiXg4rqQHHr7BJXl/view?usp=drive_link

There is a warning when running make test:

edx-documentation/en_us/open_edx_release_notes/source/eucalyptus.rst:385: WARNING: undefined label: html_heading_levels

https://courses.edx.org/courses/course-v1:W3Cx+HTML5.1x+1T2017/courseware/b246c15d3a1044ccb4564ea22fbc4821/ef075a883df1447698d557fe6f6222d0/?child=first

the link under the name : Google Code: Web Authoring Statistics: Classes.

the page not foundhttps://developers.google.com/webmasters/state-of-the-web/2005/classes?csw=1

I hope you don't mind the question, but same goes for The Boltzmann constant and the fundamental charge.

• The Boltzmann constant should be ~1.38*10^-23 J/K whereas, it is ~1.38^-23
• and The fundamental charge should be ~1.602*10^-19 C but it is written as ~1.602^-19 C

I ran the tests via make test and received an error due to dot from graphviz missing. There was no mention of needing to install graphviz. It may be good to mention this somewhere in the readme.

So I was trying to run dochealth.py but found out in order to do so, I migjht need access to readthedocs edx account, or that the edx proejcts in the readthedocs be shared with my account

It would be really helpful for me to have access to the API, bceause I tend to write tests across all docs.

Update the README to correct "EdX" capitalizations, remove outdated links, and explain our move to docs.openedx.org

@feanil I'm happy to do a cleanup pass, but probably can't add the detail you can about the moving strategy/timeline

Ideally, we would like to split edX (2U) documentation from this Open edX documentation.

The challenge is how we accomplish these (incompatible) goals:

• Keep edx-specific details out of an openedx-org repo
• Publish docs that make sense to a edx.org-interested reader without expecting them to flip between an Open edX source and an edx.org source
• Don’t duplicate source information

This ticket can be used to collect ideas, or detailed problems, for how this might be accomplished.

The sphinx linking systems, intersphinx_mapping, links, and shared, is currently in a state of spaghetti and needs to be straightened out via refactoring.

The documentation for feature flags mentions lms.env.json and similar files. I think it's worth mentioning (in the guideline) that Ansible is the recommended way for building such files.

Additionally, the documentations features Python code when mentioning JSON files. While one can guess and do the right thing. I'd rather see a JSON syntax instead of Python.

Python: Notice the missing double quotes " and the constant True:

FEATURES = {
    'LICENSING': True,
    ...

JSON: Notice the lowercase true and the double quotes ":

"FEATURES": {
    "LICENSING": true, 
    ...

[email protected] --> [email protected]

Vagrant file is missing in the below location

https://github.com/edx/edx-documentation/blob/named-release-cypress/en_us/install_operations/source/devstack/install_devstack.rst

To expand access to the Open edX platform, we'd like to have all the relevant documentation also be translated. Because the master version of documentation can be more volatile, we would instead like to maintain translated versions of named releases.

AC:

• #2029
• #2026
• #2027
• #2028

Hello,

I am thinking of creating a collection of questions and answers with additional detailed explanations.

A web search brought me to Open Learning XML? (https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/what-is-olx.html)
My desired output-format would be a pdf-file, or lets say two version of the pdf (one with one the questions and the possible
solutions) and the other with the questions, the correct solutions and the detailed explanations.

The example and code listing at 11.23.1.1. Example Multiple Choice Problem
(https://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/problem-xml/multiple_choice.html)
seem like a suitable format for me.

At this point my question comes into play, are there any alread realized ways to achieve my desired result? An XLST file or XSD?

Thank you

Andreas