Fix YAML/JSON confusion #1838
Merged
Fix YAML/JSON confusion #1838
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
|
Thanks for the pull request, @silviot! I've created OSPR-3789 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
openedx-webhooks
added
needs triage
open-source-contribution
|
Yikes! Good catch! |
|
@silviot 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
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.
The current documentation to configure SAML authentication instructs to edit the
lms.auth.jsonJSON file.It also warns the user that these changes will be overwritten on the first subsequent ansible run.
But when it comes to suggest how to edit the JSON file, wrong instructions are given: the YAML syntax is used, which won't work for the JSON file.
A seasoned person might not even notice the problem and use the correct syntax anyway, but IMHO it could be very misleading for a beginner.
Sorry for removing everything from the Github issue template. I hope this PR can be useful as it stands.