adaptdk/adapt-essentials-color-picker

Color app for Contentful created with the Contentful App SDK

adapt-essentials-color-picker's Issues

Application Logo

We need a logo for the app before submitting it to Contentful's Marketplace #5

• The logo should tell you that it's part of Adapt Essentials and also that it's for a Color design system
• Quick sketches I've done, feel free to ignore these: #4 (comment)

Add Adapt logo to the src directory

In order to submit to the contentful app marketplace, we must include a logo.

1. Add the adapt logo as an svg to the src directory of this repo. EG src/logo.svg

Requesting app review

When #4 is done, request app review based on the information here: https://www.contentful.com/help/marketplace-app-requirements/

There is a form to fill out here: https://contentful.typeform.com/to/fHkaviJq

Document installation, configuration, and usage

Summary

In order to get the app in the Contentful Marketplace the app, it must be documented. Please document the following

1. Once installed, how do I configure the app? Eg, do I have to add some global colors?
2. How do I configure the app on a particular field?
3. How do I validate against colors provided in the app?
4. What type of output can I expect from the api when I go to use the app? How might this fit into my design system?

Every app must include a support email or link where a user can request support or ask questions about the app

Setup a UX friendly issue template, maybe look into github's new templates instead of a simple .md file

Requirements for listing the app in Contentful's App Marketplace

• License agreement
• Link to privacy policy
• Every app should be thoroughly documented, covering installation, configuration, and usage
• #6
• Review your app using manual or automated tools to ensure that you are using up to date packages (if used) and that your app has no known vulnerabilities
  • Let's setup dependabot
• Ensure that the permissions required by the app are reasonable. For example, an app doing translations should not need access to users or data about other spaces
• Ensure that the UI/UX of the app:
  • Looks and feels like Contentful, using Forma36 styled components wherever possible
  • Does not “break” the surrounding Contentful experience. For example, iFrames or overlays should not unexpectedly hide or cover other features
  • Fits simply into the Contentful experience. Avoid unnecessary complexity or steps if possible.
• Apps should be reviewed for typos or grammatical issues before submission
• A clear name for your app - generally your business/product name
• A tagline, description, feature list, and requirements list for your app
• Logo(s) and screenshots - these will be used in the Marketplace, on your developer page, as well as in the technology partner page

Update readme for submission to the Contentful Marketplace

In order to submit our app to the Contentful Marketplace, we have to add links to the following in our readme:

1. link to our privacy policy: https://adaptagency.com/privacy-policy
2. Link to this repositories issue queue for opening issues or feature requests: https://github.com/adaptdk/contentful-color-app/issues

App needs a name and description of features

In order to submit to the Contentful Marketplace, the app requires that we define the following:

1. clear name for your app - generally your business/product name
2. A tagline, description, feature list, and requirements list for your app

Notes

My suggestions:

Name: Adapt Toolkit: Color Tokens
Description: Configure your design system color tokens in Contentful in order to keep your editors, developers, and designers all on the same page.