openedx / openedx/docs.openedx.org
Add a How-To doc for overriding headers and footers in an MFE
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
I was trying to track down our documentation on doing MFE header/footer overrides, and found that we seem to have lost it in the transition to docs.openedx.org.
This commit in particular deleted a page in edx-developer-docs that listed out environment variables, how to do branding, how to override headers/footers, etc:
It replaced the page with a link to frontend-platform's documentation, which is merely doc for the frontend-platform library, not for our "Frontend Platform" in general. That JSDoc site isn't really a good place for the info we lost.
I'm happy to work on this task, but would love some input as to where we'd like this info to live now.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the deleted edx-developer-docs page at commit a4d425d109fc6fddb7efb23762175ab5a8cf5ac9 and comparing it with the frontend-platform documentation. First determine where the recovered MFE header/footer override guidance should live; done means a new how-to documents the relevant environment variables, branding, and header/footer overrides in the agreed location.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100