Skip to content

Commit 485cf02

Browse files
arbrandesclaude
andcommitted
chore: rename package to frontend-app-instructor-dashboard
Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0a55f65 commit 485cf02

8 files changed

Lines changed: 1401 additions & 225 deletions

File tree

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ pull_translations:
6262
&& atlas pull $(ATLAS_OPTIONS) \
6363
translations/frontend-base/src/i18n/messages:frontend-base \
6464
translations/paragon/src/i18n/messages:paragon \
65-
translations/frontend-app-instruct/src/i18n/messages:frontend-app-instruct
65+
translations/frontend-app-instructor-dashboard/src/i18n/messages:frontend-app-instructor-dashboard
6666

67-
$(intl_imports) frontend-base paragon frontend-component-header frontend-component-footer frontend-app-instruct
67+
$(intl_imports) frontend-base paragon frontend-component-header frontend-component-footer frontend-app-instructor-dashboard
6868

6969
clean:
7070
rm -rf dist

README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
frontend-app-instruct
2-
#############################
1+
frontend-app-instructor-dashboard
2+
#################################
33

44
|license-badge| |status-badge| |ci-badge| |codecov-badge|
55

@@ -26,7 +26,7 @@ Getting Started
2626
***************
2727

2828
After copying the template repository, you'll want to do a find-and-replace to
29-
replace all instances of ``frontend-app-instruct`` with the name of
29+
replace all instances of ``frontend-app-instructor-dashboard`` with the name of
3030
your new repository. Also edit index.html to replace "Application Template"
3131
with a friendly name for this application that users will see in their browser
3232
tab.
@@ -47,7 +47,7 @@ Cloning and Startup
4747

4848
1. Clone your new repo:
4949

50-
``git clone https://github.com/openedx/frontend-app-instruct.git``
50+
``git clone https://github.com/openedx/frontend-app-instructor-dashboard.git``
5151

5252
2. Use node v20.x.
5353

@@ -58,7 +58,7 @@ Cloning and Startup
5858

5959
3. Install npm dependencies:
6060

61-
``cd frontend-app-instruct && npm install``
61+
``cd frontend-app-instructor-dashboard && npm install``
6262

6363
4. Update the application port to use for local development:
6464

@@ -78,7 +78,7 @@ Project Structure
7878
The source for this project is organized into nested submodules according to
7979
the `Feature-based Application Organization ADR`_.
8080

81-
.. _Feature-based Application Organization ADR: https://github.com/openedx/frontend-app-instruct/blob/master/docs/decisions/0002-feature-based-application-organization.rst
81+
.. _Feature-based Application Organization ADR: https://github.com/openedx/frontend-app-instructor-dashboard/blob/master/docs/decisions/0002-feature-based-application-organization.rst
8282

8383
Internationalization
8484
====================
@@ -168,7 +168,7 @@ channel`_.
168168
For anything non-trivial, the best path is to open an issue in this repository
169169
with as many details about the issue you are facing as you can provide.
170170

171-
https://github.com/openedx/frontend-app-instruct/issues
171+
https://github.com/openedx/frontend-app-instructor-dashboard/issues
172172

173173
For more information about these options, see the `Getting Help`_ page.
174174

@@ -213,23 +213,23 @@ The assigned maintainers for this component and other project details may be
213213
found in `Backstage`_. Backstage pulls this data from the ``catalog-info.yaml``
214214
file in this repo.
215215

216-
.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-instruct
216+
.. _Backstage: https://open-edx-backstage.herokuapp.com/catalog/default/component/frontend-app-instructor-dashboard
217217

218218
Reporting Security Issues
219219
*************************
220220

221221
Please do not report security issues in public, and email security@openedx.org instead.
222222

223-
.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-instruct.svg
224-
:target: https://github.com/openedx/frontend-app-instruct/blob/main/LICENSE
223+
.. |license-badge| image:: https://img.shields.io/github/license/openedx/frontend-app-instructor-dashboard.svg
224+
:target: https://github.com/openedx/frontend-app-instructor-dashboard/blob/main/LICENSE
225225
:alt: License
226226

227227
.. |status-badge| image:: https://img.shields.io/badge/Status-Maintained-brightgreen
228228

229-
.. |ci-badge| image:: https://github.com/openedx/frontend-app-instruct/actions/workflows/ci.yml/badge.svg
230-
:target: https://github.com/openedx/frontend-app-instruct/actions/workflows/ci.yml
229+
.. |ci-badge| image:: https://github.com/openedx/frontend-app-instructor-dashboard/actions/workflows/ci.yml/badge.svg
230+
:target: https://github.com/openedx/frontend-app-instructor-dashboard/actions/workflows/ci.yml
231231
:alt: Continuous Integration
232232

233-
.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-instruct/coverage.svg?branch=main
234-
:target: https://codecov.io/github/openedx/frontend-app-instruct?branch=main
233+
.. |codecov-badge| image:: https://codecov.io/github/openedx/frontend-app-instructor-dashboard/coverage.svg?branch=main
234+
:target: https://codecov.io/github/openedx/frontend-app-instructor-dashboard?branch=main
235235
:alt: Codecov

catalog-info.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
apiVersion: backstage.io/v1alpha1
55
kind: Component
66
metadata:
7-
name: "frontend-app-instruct"
7+
name: "frontend-app-instructor-dashboard"
88
description: "MFE Pages for the Instructor Dashboard"
99
links:
10-
- url: "https://github.com/openedx/frontend-app-instruct/blob/main/README.rst"
10+
- url: "https://github.com/openedx/frontend-app-instructor-dashboard/blob/main/README.rst"
1111
title: "README"
1212
icon: "Article"
1313
annotations:
@@ -23,6 +23,6 @@ metadata:
2323
# component.
2424
openedx.org/arch-interest-groups: ""
2525
spec:
26-
owner: group:committers-frontend-app-instruct
26+
owner: group:committers-frontend-app-instructor-dashboard
2727
type: "library"
2828
lifecycle: "experimental"

docs/decisions/0001-record-architecture-decisions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ The key decision point was whether to create a traditional legacy MFE and later
3434
Decision
3535
--------
3636

37-
We will create the `frontend-app-instruct` repository as a **frontend-base native micro-frontend** that will replace the legacy Instructor Dashboard pages. This initiative combines the MFE conversion with an incremental shift to using Paragon components and modern styling.
37+
We will create the `frontend-app-instructor-dashboard` repository as a **frontend-base native micro-frontend** that will replace the legacy Instructor Dashboard pages. This initiative combines the MFE conversion with an incremental shift to using Paragon components and modern styling.
3838

39-
The `frontend-app-instruct` MFE will provide the following instructor tools:
39+
The `frontend-app-instructor-dashboard` MFE will provide the following instructor tools:
4040

4141
* Course Information (enrollment info, basic course info, pending tasks)
4242
* Membership Management (student enrollment and access control)
@@ -93,7 +93,7 @@ The team will need to create a DEPR (Deprecation) document for the legacy Instru
9393

9494
**Long-term Ownership and Maintainership**
9595

96-
The long-term maintainership for the Instruct product has been established with WGU team members Diana Villalvazo (@diana-villalvazo-wgu) and Jesse Stewart (@wgu-jesse-stewart) serving as the initial maintainers under a new "committers-frontend-app-instruct" group. Schema continues to support early stages of product definition through documentation updates, QA pipeline recommendations, and release testing coordination to help ensure long-term stability and continuity during the transition period.
96+
The long-term maintainership for the Instruct product has been established with WGU team members Diana Villalvazo (@diana-villalvazo-wgu) and Jesse Stewart (@wgu-jesse-stewart) serving as the initial maintainers under a new "committers-frontend-app-instructor-dashboard" group. Schema continues to support early stages of product definition through documentation updates, QA pipeline recommendations, and release testing coordination to help ensure long-term stability and continuity during the transition period.
9797

9898
References
9999
----------

0 commit comments

Comments
 (0)