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

Add a How-To doc for overriding headers and footers in an MFE #272

Open
davidjoy opened this issue Mar 15, 2023 · 2 comments
Open

Add a How-To doc for overriding headers and footers in an MFE #272

davidjoy opened this issue Mar 15, 2023 · 2 comments

Comments

@davidjoy
Copy link

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:

openedx-unsupported/edx-developer-docs@a4d425d

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.

@davidjoy
Copy link
Author

Tagging @feanil just in case you have any more context you'd like to add on the removal (maybe I've just lost where it ended up!)

@feanil
Copy link
Contributor

feanil commented Mar 16, 2023

@davidjoy thanks for catching this. I think the missing seems like it would best fit as a new How-To in the developer section, something like "How to override the header/footer in an MFE".

You can use the template for a new how-to which can be found here.

@feanil feanil changed the title Lost MFE documentation from edx-developer-docs Add a How-To doc for overriding headers and footers in an MFE Mar 16, 2023
@github-project-automation github-project-automation bot moved this to Backlog - Other in docs.openedx.org Mar 16, 2023
@feanil feanil moved this from Backlog - Other to Backlog - To Write in docs.openedx.org Mar 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Status: Backlog - To Write
Development

No branches or pull requests

2 participants