Document Arbitrary Metadata for All Content #103
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Screenshots from testing the Author: Content: Page: Tag: |
Merged
mansona
requested changes
Feb 1, 2021
There was a problem hiding this comment.
nice work, some small suggestions about the default data for a blueprint but when that is fixed it should be good to go.
Also can you revert your changes to package-lock.json as this PR doesn't affect the deps (I think it's because you're using npm@6 instead of npm@7)
elwayman02
force-pushed
the
meta
branch
2 times, most recently
from
fc5fc99
to
980c644
Compare
|
@mansona I've addressed or responded to all the comments. Can you do another pass? |
|
What's the status here? |
This was referenced Sep 8, 2021
This change adds a `meta` attribute to the Front Matter section of every type of content supported by `empress-blog`. This attribute is treated as an arbitrary JSON blob by the Ember-Data models, supporting string, array, and/or object formats. The `meta` attribute is not used by `empress-blog` by default, but it enables developer support for adding metadata to authors, content, pages, and tags. The blueprints have been updated such that all generators will add a `meta` attribute, making it clear to users that it is supported. Documentation has been updated to mention this feature is available, and some of the default generated content has had different examples of a `meta` attribute added in those markdown files. I am not sure how to test this, however, since the existing `meta-tests` appears to exclusively assert the output of Front Matter attributes rendered to the DOM, and by default the `meta` attribute is not rendered by `empress-blog` without custom features being added. However, it is clear from running Ember Inspector that the Ember-Data models have correctly parsed each of the `meta` examples added by this change.
mansona
changed the title
|
I've changed the title of this PR so that it's about documentation now, since the implementation was merged in #142 👍 We can continue our discussions and get this merged (eventually 😂 ) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@nickschot if you could review this, that would be great. I spoke about this feature and its implementation details with @mansona today, and I believe we're both on the same page about using this approach to enable arbitrary metadata in user land.
This change adds a
metaattribute to the Front Matter section of every type of content supported byempress-blog. This attribute is treated as an arbitrary JSON blob by the Ember-Data models, supporting string, array, and/or object formats.The
metaattribute is not used byempress-blogby default, but it enables developer support for adding metadata to authors, content, pages, and tags. The blueprints have been updated such that all generators will add ametaattribute, making it clear to users that it is supported.Documentation has been updated to mention this feature is available, and some of the default generated content has had different examples of a
metaattribute added in those markdown files.I am not sure how to test this, however, since the existing
meta-testsappears to exclusively assert the output of Front Matter attributes rendered to the DOM, and by default themetaattribute is not rendered byempress-blogwithout custom features being added. However, it is clear from running Ember Inspector that the Ember-Data models have correctly parsed each of themetaexamples added by this change.