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

FC-0068 docs: Update How-tos edunext 1 #643

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Apgomeznext
Copy link
Contributor

@Apgomeznext Apgomeznext commented Dec 11, 2024

This PR cleans the How to Configure Your Course for Content Experiments and Add Content Experiments to Your Course, creates the new documents necessary to accomplish the Style Guide and the Diataxis Criteria, and tests the Maintenance Chart in some of these documents.

This PR cleans the How to Configure Your Course for Content Experiments, creates new documents, and tests the maintenance table.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 11, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 11, 2024

Thanks for the pull request, @Apgomeznext!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/docs-openedx-org-maintainers. Tag them in a comment and let them know that your changes are ready for review.

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.

@Apgomeznext Apgomeznext changed the title FC-0068 docs: maintenance table test FC-0068 docs: Update How-tos edunext 1 Dec 11, 2024
@Apgomeznext Apgomeznext marked this pull request as ready for review December 11, 2024 22:22
To enable content experiments in your course, you add ``split_test`` to the
**Advanced Module List** in Advanced Settings.

.. note::
Copy link
Contributor

Choose a reason for hiding this comment

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

Why delete this note, and the L22? It might not be obvious how the phrase split_test relates to experimnets, and L22 tells in advance what the steps will walk you through

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This information is passed to the specific How-to create_content_experiment.rst (source/educators/how-tos/advanced_features/create_content_experiment.rst). I had to break this how-to into several documents, but I can add that information here again if necessary.

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
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.

3 participants