very-simple-editor-assistant (example entry location app) #9891
Conversation
This file contains hidden or 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
👷 Deploy request for ecommerce-app-base-components pending review.Visit the deploys page to approve it
|
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension. |
Muzietto
changed the title
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.
Purpose
I have created a very simple entry location app that solves a common problem not yet documented.
It is often necessary to re-label the fields in the editor's page: our editors ask us to see fields labeled in a different manner depending on the context in which a given content type is used. We don't aim to rename the field, but just to label it differently for the editor's sake. Please see the new labels indicated by the red arrows:
Approach
The new labels are specified inside a JSON file, depending on the contentTypeId. The app can be easily expanded to include all sorts of process information besides the editor label.
All the details + an example JSON config file are provided in the README.md file.
The JSON file in the codebase (vsea.json) is related to the image in the description of this PR, whereas the README.md mentions a more abstract yet very similar setup.
Testing steps
This app is very, very simple. I haven't seen the need for writing tests.
PLEASE NOTE that in the past I have submitted another pull request for another example app of mine. I was informed that your automated tests did not run initially; therefore I spent a considerable amount of time trying to please them, without success. At the end the tests were successfully run by one of your engineers.
Breaking Changes
No breaking changes. Just vanilla JS in the vanilla Apps Framework.
Dependencies and/or References
This app uses the SingleLineEditor from package '@contentful/field-editor-single-line'
Deployment
No special deployment care is needed. The app is meant to run on localhost.