Skip to content

Commit b1d9736

Browse files
kdmccormickclaude
andcommitted
feat!: Rename brand-example-purple -> brand-sample
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent eaa573b commit b1d9736

16 files changed

Lines changed: 11 additions & 63 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This sample plugin showcases the **Open edX Hooks Extension Framework**, which a
3333
| **Events (Signals)** | React to platform events | [Open edX Events Guide](https://docs.openedx.org/projects/openedx-events/en/latest/) | [`platform-plugin-sample/openedx_sample_plugin/signals.py`](./platform-plugin-sample/openedx_sample_plugin/signals.py) | Integrating with external systems, audit logging |
3434
| **Filters** | Modify platform behavior | [Using Open edX Filters](https://docs.openedx.org/projects/openedx-filters/en/latest/how-tos/using-filters.html) | [`platform-plugin-sample/openedx_sample_plugin/pipeline.py`](./platform-plugin-sample/openedx_sample_plugin/pipeline.py) | Customizing business logic, URL redirects |
3535
| **Frontend Slots** | Customize MFE interfaces | [Frontend Plugin Slots](https://docs.openedx.org/en/latest/site_ops/how-tos/use-frontend-plugin-slots.html) | [`frontend-plugin-sample/`](./frontend-plugin-sample/) | UI customization, adding new components |
36-
| **Brand Packages** | Customize theming | [Open edX Brand Package Interface](https://github.com/openedx/brand-openedx) | [`brand/`](./brand/) | UI theming |
36+
| **Brand Packages** | Customize theming | [Open edX Brand Package Interface](https://github.com/openedx/brand-openedx) | [`brand-sample/`](./brand-sample/) | UI theming |
3737
| **Tutor Plugin** | Deploy plugins easily | [Tutor Plugin Development](https://docs.tutor.edly.io/) | [`tutor-contrib-sample/`](./tutor-contrib-sample/) | Simplified deployment and configuration |
3838

3939
## Quick Start Guide

brand/README.md renamed to brand-sample/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# brand-example-purple
1+
# brand-sample
22

33
**This is a simple example brand package that changes the `brand` color to purple.**
44

@@ -22,7 +22,7 @@
2222

2323
1. Stop `tutor` (`tutor dev stop` or `tutor local stop`)
2424
2. Navigate to your local tutor plugins directory (`tutor plugins printroot`)
25-
3. Create a new `purple-jsdelivr.py` plugin file with the following content
25+
3. Create a new `sample-jsdelivr.py` plugin file with the following content
2626

2727
```py
2828
import json
@@ -33,7 +33,7 @@ paragon_theme_urls = {
3333
"light": {
3434
"urls": {
3535
"default": "https://cdn.jsdelivr.net/npm/@openedx/paragon@$paragonVersion/dist/light.min.css",
36-
"brandOverride": "https://cdn.jsdelivr.net/gh/openedx/sample-plugin@main/brand/dist/light.min.css"
36+
"brandOverride": "https://cdn.jsdelivr.net/gh/openedx/sample-plugin@main/brand-sample/dist/light.min.css"
3737
}
3838
}
3939
}
@@ -51,7 +51,7 @@ hooks.Filters.ENV_PATCHES.add_item(
5151
)
5252
```
5353

54-
4. Enable the plugin (`tutor plugins enable purple-jsdelivr`)
54+
4. Enable the plugin (`tutor plugins enable sample-jsdelivr`)
5555
5. Start `tutor` (`tutor dev start lms cms mfe` or `tutor local start lms cms mfe`)
5656

5757
#### Using the [Tutor Paragon Plugin](https://github.com/openedx/openedx-tutor-plugins/tree/main/plugins/tutor-contrib-paragon) (Recommended)
File renamed without changes.
File renamed without changes.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# brand-example-purple
1+
# brand-sample
22

33
This directory contains the source design tokens for the example brand package.
44

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
{
2-
"name": "brand-example-purple",
2+
"name": "brand-sample",
33
"version": "0.0.1",
44
"description": "An example design-token-based brand package for Open edX applications.",
55
"repository": {
66
"type": "git",
77
"url": "git+https://github.com/openedx/sample-plugin.git",
8-
"directory": "brand"
8+
"directory": "brand-sample"
99
},
1010
"author": "Brian Smith",
1111
"license": "MIT",
1212
"bugs": {
1313
"url": "https://github.com/openedx/sample-plugin/issues"
1414
},
15-
"homepage": "https://github.com/openedx/sample-plugin/tree/main/brand#readme",
15+
"homepage": "https://github.com/openedx/sample-plugin/tree/main/brand-sample#readme",
1616
"scripts": {
1717
"build-tokens": "paragon build-tokens --source ./tokens/src --build-dir ./paragon/css --source-tokens-only --exclude-core",
1818
"build-scss": "paragon build-scss --themesPath ./paragon/css/themes --defaultThemeVariants light --excludeCore",

0 commit comments

Comments
 (0)