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

Update README.md #67

Closed
wants to merge 2 commits into from
Closed

Conversation

mariajgrimaldi
Copy link
Contributor

Description

Describe what this pull request changes, and why. Include implications for people using this change.

Useful information to include:

  • Which user roles will this change impact? Common user roles are "Learner", "Course Author",
    "Developer", and "Operator".
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
  • Provide links to the description of corresponding configuration changes. Remember to correctly annotate these
    changes.

Testing instructions

Please provide detailed step-by-step instructions for testing this change.

Additional information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
  • Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.

Checklist for Merge

  • Tested in a remote environment
  • Updated documentation
  • Rebased master/main
  • Squashed commits


```bash
tutor plugins enable distro
```

2. Configure Distro. The plugin manages a set of settings that you can add, refer to the following documentation to know the Distro variables:
2. **Configure the Distro plugin**: this plugin adds a new set of settings use to further customize your Open edX installation. Refer to the following documentation to know the Distro variables:
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
2. **Configure the Distro plugin**: this plugin adds a new set of settings use to further customize your Open edX installation. Refer to the following documentation to know the Distro variables:
2. **Configure the Distro plugin**: this plugin adds a new set of settings used to further customize your Open edX installation. Refer to the following documentation to know the Distro variables:

@@ -189,15 +221,19 @@ export DOCKER_BUILDKIT=1
tutor images build -a BUILDKIT_INLINE_CACHE=1 --docker-arg="--cache-from" --docker-arg="<docker-user>/<docker-repository>:<image-tag>" -a EDX_PLATFORM_REPOSITORY=<your-edx-repo> -a EDX_PLATFORM_VERSION=<branch> openedx
```

### SUGGESTION: why is this needed? instead of using tutor images build ###
Copy link
Contributor

Choose a reason for hiding this comment

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

It's based on the tutor documentation but I think I can refer to the official tutor documentation and get rid of this section

@dcoa dcoa force-pushed the dcoa/improve-docs branch 7 times, most recently from 2bc3dea to 4ae3402 Compare June 25, 2024 08:37
@mariajgrimaldi
Copy link
Contributor Author

Closed in favor of #66

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.

4 participants