Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix course/library keys in the readme #49

Closed
wants to merge 2 commits into from

Conversation

kdmccormick
Copy link
Member

@kdmccormick kdmccormick commented Feb 7, 2024

This updates the README to show the correct course key and library key. Respectively, these are determined by the values on the first line of:

@sarina @jswope00 , while we're here, are you folks happy with locking in the keys course-v1:Axim+DemoX+demo_course and library-v1:Dummy+RESP_Q1? I ask only because we can easily change them now (by editing those two XML files), but as soon as people start using the new demo course, we won't be able to change them without disrupting peoples' progress in the course.

README.rst Outdated Show resolved Hide resolved
@@ -17,11 +17,11 @@ This repository contains a course and some libraries that you can import into yo
- Download
- Source OLX
* - *Open edX demo Course*
- ``course-v1:demo+Course+1``
- ``course-v1:Axim+DemoX+demo_course``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- ``course-v1:Axim+DemoX+demo_course``
- ``course-v1:Open_edX+DemoX+demo_course``

Maybe? I think I want to position this as the community's demo course, not Axim's

- `<./dist/demo-course.tar.gz>`_
- `<./demo-course>`_
* - *Open edX Example Content Library*
- ``library-v1:demo+ContentLibrary``
- ``library-v1:Dummy+RESP_Q1``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To me, "Demo+ContentLibrary" makes more sense than your suggestion, but you know libraries way better than me. Why "RESP_Q1"?

Copy link
Member Author

@kdmccormick kdmccormick Feb 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sarina These aren't my suggestions, I'm just updating the README to reflect what's in the OLX.

The library is titled "Respiratory System Question Bank 1", and it contains questions on the respiratory system to demonstrate how one can use libraries as dynamic problem banks. So, personally, I'd name it library-v1:Open_edX+DemoRespiratoryQuestions. I think using the same org (Open_edX) as the course makes it clearer that they belong together.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AH I'm sorry, I didn't read carefully enough >_<

I agree that it would be preferable to use your suggestion here, and mine above, if that change can be made.

@kdmccormick
Copy link
Member Author

Closed in favor of #50

@kdmccormick kdmccormick closed this Feb 8, 2024
@kdmccormick kdmccormick deleted the kdmccormick/readme-keys branch February 8, 2024 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants