-
Notifications
You must be signed in to change notification settings - Fork 59
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
removing and replacing links #787
Conversation
Thanks for the pull request, @jesgreco! This repository is currently maintained by @openedx/docs-openedx-org-maintainers. Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
add_update_full_profile.rst add_calculator.rst
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like this was deleted because of a spacing error?
Seems fairly moot, though, since Add Calculator is an isolated doc and doesn't have specific See Also docs. Not asking for a change here, just documenting for clarity if we ever look back at this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just forgot about replacing links there on the see also table for add_calculator file, now it is fixed.
@@ -63,7 +63,9 @@ create a taxonomy of cities, like this: | |||
|
|||
For a tag like “United States” which is a “root” tag in the taxonomy, we leave “parent_id” empty. We can also leave “comments” empty. | |||
|
|||
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read :ref:`Why does each tag need an ID when importing a taxonomy?` | |||
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read `Why does each tag need an ID when importing a taxonomy <https://docs.openedx.org/en/latest/educators/concepts/advanced_features/why_taxonomy_tag_id.html>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be a :ref:
to the document, not a hardcoded link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, I'll check it again, since :ref: option gives me an error of undefined labels, and some docs use hardcoded links also.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I could do it! =) the link is fixed as a :ref:
|
||
The `Open edX Demo Course <https://sandbox.openedx.org/courses/course-v1:OpenedX+01-2024+2024-1/about>`_ course is designed to discuss the tools and features that you can leverage in your learning program. After providing details about the platform, the course shows the different types of content that can be created, showcase the variety of assessment tools, and explore the different ways that you can engage your learners with social interactions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are you deleting this line? It is useful
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've discussed with John that we needed to delete such link (leading to Sandbox) and, if I deleted such a link, there would be no sense to leave the rest of the paragraph without that link. Let me know what I need to do, and I'll do it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah. I disagree but I'll defer to John.
@@ -63,7 +63,9 @@ create a taxonomy of cities, like this: | |||
|
|||
For a tag like “United States” which is a “root” tag in the taxonomy, we leave “parent_id” empty. We can also leave “comments” empty. | |||
|
|||
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read `Concept: Why does each tag need an ID when importing a taxonomy? <https://openedx.atlassian.net/l/cp/U1i001z1>`_. | |||
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read :ref: `Why does each tag need an ID when importing a taxonomy` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This ref doesn't render. Do you check the build? None of the See Alsos render. I think it's because you cannot have a space between :ref:
and the backtick. https://docsopenedxorg--787.org.readthedocs.build/en/787/educators/how-tos/content-tagging-how-tos/build_taxonomy_using_template.html
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read :ref: `Why does each tag need an ID when importing a taxonomy` | |
**Choosing an ID:** The “id” column is required, but its exact value is not particularly important at this stage. The main requirement is that each row (each tag) has a unique ID. (Though remember that the “values” of each row also must be unique.) For learning purposes, feel free to use numbers like 1, 2, 3, 4 as the IDs. You could also just make the “id” the same as the “value” (i.e. put “United States” as both the ID and the value), or make up a short ID like “USA”. To understand more, and learn how IDs play an important role when updating the taxonomy, please read :ref:`Why does each tag need an ID when importing a taxonomy` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please check the rendered build for all your pages and ensure the ref links all render properly.
@sarina I have some errors that I can work tomorrow. And, I'll check the rendered build for my pages regarding ref links as from tomorrow. |
The build is failing because your ref isn't the title of the page. The page title has a ?. https://docs.openedx.org/en/latest/educators/concepts/advanced_features/why_taxonomy_tag_id.html |
nope :( I've added it, the error is this one: related to undefined labels :/ @jswope00 can you please help me? |
@jesgreco you just need to use the reference tag (I'm not 100% sure that is the right terminology) instead of the actual title. I think this'll do it |
And see my note about bringing back the link to and paragraph about the DemoX course. I'm partial to that one :) |
@jesgreco it looks like you never wrote the
not
I'm going to close this PR and work on fixing these errors in #799. |
removing unnecessary link to Eucalytus release and adjusting see also table links for add_update_full_profile.rst