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

removing and replacing links #787

Closed
wants to merge 15 commits into from
Closed

Conversation

jesgreco
Copy link
Contributor

removing unnecessary link to Eucalytus release and adjusting see also table links for add_update_full_profile.rst

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 16, 2025
@openedx-webhooks
Copy link

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.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@jesgreco jesgreco requested review from sarina and jswope00 January 17, 2025 13:45
Copy link
Contributor

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.

Copy link
Contributor Author

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>`_
Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.
Copy link
Contributor

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

Copy link
Contributor Author

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.

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 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`
Copy link
Contributor

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

Suggested change
**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`

Copy link
Contributor

@sarina sarina left a 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.

@jesgreco
Copy link
Contributor Author

@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.

@sarina
Copy link
Contributor

sarina commented Jan 21, 2025

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

@jesgreco
Copy link
Contributor Author

nope :( I've added it, the error is this one:
/home/docs/checkouts/readthedocs.org/user_builds/docsopenedxorg/checkouts/787/source/educators/how-tos/content-tagging-how-tos/build_taxonomy_using_template.rst:66: WARNING: undefined label: 'why does each tag need an id when importing a taxonomy?'

related to undefined labels :/ @jswope00 can you please help me?

@jswope00
Copy link
Contributor

@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
:ref: tag-ids-for-taxonomy-import

@jswope00
Copy link
Contributor

And see my note about bringing back the link to and paragraph about the DemoX course. I'm partial to that one :)

@sarina
Copy link
Contributor

sarina commented Jan 22, 2025

@jesgreco it looks like you never wrote the :ref: syntax properly. I'm finding 231 places where you wrote :ref: followed by a space, which is incorrect syntax. Further, you're trying to reference the document title, not the tag, for example in https://raw.githubusercontent.com/openedx/docs.openedx.org/refs/heads/main/source/educators/how-tos/course_development/exercise_tools/enable_completion.rst you need to write:

:ref:`Enable Completion`

not

:ref: `Enable the Completion Tool`

I'm going to close this PR and work on fixing these errors in #799.

@sarina sarina closed this Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

5 participants