-
Notifications
You must be signed in to change notification settings - Fork 767
Added migration instructions for the customized index.html #9042
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
Added migration instructions for the customized index.html #9042
Conversation
|
Hi @wrdsnd , are these changes tied to a release or can they be merged after review? |
|
Hi @quinntracy! There is no hurry, this is not tied to a release. |
|
@wrdsnd Great, I'll take a look and merge after review |
|
@Robinfr can you please also take a look? |
|
|
||
| 1. Delete the custom `index.html`, or rename it temporarily. | ||
| 2. Run the local deployment and copy the app/deployment/web/index-example.html to your app/theme/web/index.html. That will be your new `index.html`. | ||
| 3. Apply any changes you want. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apply customization where required.
| 2. Run the local deployment and copy the app/deployment/web/index-example.html to your app/theme/web/index.html. That will be your new `index.html`. | ||
| 3. Apply any changes you want. | ||
|
|
||
| It is also possible to keep custom `index.html` files for both clients. To do this, name the React client index file *index-react.html*. This file will take precedence when the React client is enabled, while the `index.html` will be used for Dojo client deployments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, let's also use code blocks for index-react.html.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our style guide uses italics to clarify the name of something, which is why index-react.html is italicized rather than in code formatting. I will change the other places noted above to be in code formatting, though.
| 2. Run the local deployment and copy the app/deployment/web/index-example.html to your app/theme/web/index.html. That will be your new `index.html`. | ||
| 3. Apply any changes you want. | ||
|
|
||
| It is also possible to keep custom `index.html` files for both clients. To do this, name the React client index file *index-react.html*. This file will take precedence when the React client is enabled, while the `index.html` will be used for Dojo client deployments. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add why customers might want to do this, e.g. while they are migrating their app?
|
I opened a new PR to add @Robinfr 's feedback to this (also so @ConnorLand can take a look next week and make adjustments, where necessary). |
No description provided.