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

Documented use of ember-cli-head in Octane #81

Merged
merged 8 commits into from
Jun 22, 2020
Merged

Documented use of ember-cli-head in Octane #81

merged 8 commits into from
Jun 22, 2020

Conversation

ijlee2
Copy link
Contributor

@ijlee2 ijlee2 commented Jun 20, 2020

Description

This PR addresses the issue #70.

In addition to documenting the use of ember-cli-head in Octane apps (commit 1), I read the entire README to see how we can help the documentation be more clear and easier to understand for first-time users (commits 2-8).

I may recommend reviewing commits one at a time.

compatibility for generating head tags in server-rendered apps.
# ember-cli-head

This addon lets you populate `<head>` tag from your Ember code without any direct hacky DOM manipulation. It also provides [ember-cli-fastboot](https://github.com/ember-fastboot/ember-cli-fastboot) compatibility for generating head tags in server-rendered apps.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the URL for ember-cli-fastboot.


### Version

Take into account that version >= 0.3 of this addon require Ember 2.10+ and fastboot >=1.0.rc1. Please use 0.2.X if you don't fulfill both requirements.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the current version of ember-cli-head supports Ember 2.18+ and the current version of FastBoot is 2.x, I wondered if this subsection could be removed. Just in case, I kept the subsection.


If you make use of this mode the content of `<head>` will be the static FastBoot rendered content through the life of your App.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph used to belong to the Fastboot Only section. It got separated when the Upgrade section was added.

@ijlee2 ijlee2 marked this pull request as ready for review June 20, 2020 16:11
Copy link
Member

@rwjblue rwjblue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@rwjblue rwjblue merged commit 866ffbb into ember-fastboot:master Jun 22, 2020
@ijlee2 ijlee2 deleted the update-readme-for-Octane branch June 22, 2020 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants