-
Notifications
You must be signed in to change notification settings - Fork 44
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
submission-review-updates #186
base: main
Are you sure you want to change the base?
Conversation
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.
🤟🏼 Great job, as usual!!
A few nits here and there.
@@ -138,8 +138,27 @@ module.exports = { | |||
], | |||
}, | |||
{ | |||
title: "Submission and review", | |||
title: "Integration submission and approval", |
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.
I would omit "Integration" as it seems redundant (and splits the text in two lines), what about "Submission and Approval" or "Submission & Approval"?
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.
I shall choose this: Submission and approval
path: "/guides/review/", | ||
pages: |
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.
I'm not 100% sure about this, so please correct me if I'm wrong, but I believe we usually have an explicit submenu entry for the page that opens when you click/expand the menu.
What I'm saying is that /review/index.md
should also appear:
Submission and Approval
- Overview 👈 new, the index.md
- Submission guidelines
- Review test cases
- ...
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.
Let me check this.
# Overview | ||
|
||
This section provides a set of guidelines to help you in submitting your integrtion for review. | ||
|
||
## Submission guidelines |
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.
I would merge this into a single
# Submission guidelines
This section provides a set of guidelines to help you in submitting your integrtion for review.
You have to submit your app for approval in the [Adobe Developer Console](https://developer.adobe.com/console).
so that the main title matches the menu entry, you have the introductory sentence as a subtitle and the rest flows
In case, you might need to upgrade the following ##
to #
in the page.
- https://github.com/nimithajalal | ||
--- | ||
|
||
# Rejection reasons |
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.
For consistency, I would pick as a title Handle rejections to match the submenu
- https://github.com/nimithajalal | ||
--- | ||
|
||
# Overview |
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 title/menu mismatch, I wouldn't start with Overview as a #
Once your integration passes all stages of review, you will receive an approval notification, and your integration will be published or distributed as required. | ||
If it was rejected, we will include the reasons for rejection along with any next steps. If you'd like to back and edit your submission, you can do so in the Developer Console. Checkout how to [handle rejections](./rejections.md) here. |
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.
For the future, it would be nice to have like a screenshot of an anonymized approval or rejection letter, just to give partners a sense of what to expect.
Totally minor/low-priority.
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.
Yeah, this can be arranged.
# Overview | ||
|
||
This guides helps you review the test cases before you submit your integration for review. | ||
|
||
## Review Test Cases |
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.
Doubts about starting with Overview again :-)
|
||
### Public Profile Content | ||
|
||
- [ ] Name adheres to Adobe brand guidelines. |
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.
LOVE the checkboxes!!! Great idea!!
|
||
- [ ] Name adheres to Adobe brand guidelines. | ||
- **Example**: Ensure the public profile name is "ABCCompany" and not "ABC123". | ||
- [ ] Logo does not include Adobe icons or dummy icons. |
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.
![image](https://private-user-images.githubusercontent.com/5939127/410008374-b19306ba-4ea7-415e-869d-9b8e492e33a0.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNDk5OTYsIm5iZiI6MTczOTI0OTY5NiwicGF0aCI6Ii81OTM5MTI3LzQxMDAwODM3NC1iMTkzMDZiYS00ZWE3LTQxNWUtODY5ZC05YjhlNDkyZTMzYTAucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTFUMDQ1NDU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MjU3OTExNTk1YzA1ZWFkMGMzMGZhZjkwNTVjOWZlMWY5NmQyYWRjMjhhM2ZmN2NhYzJmNjI0N2ZlNTc1M2E5ZCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.nXjlaTOITX9YGpCXZu-C6ngCqrSKL02hUlGpSAv-dD0)
Oopsie, they turn out as disabled
?!
I've investigated a bit, and apparently you can create checkboxes in markdown as [ ]
and [x]
but they aren't clickable (like, they're either unchecked or checked.
But I tried replacing them with <input type="checkbox"/>
and this produces an actual, functional checkbox, so although tedious you might need to replace all [ ]
with it.
![image](https://private-user-images.githubusercontent.com/5939127/410010805-f716559e-86d3-4353-9647-1f101890920b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNDk5OTYsIm5iZiI6MTczOTI0OTY5NiwicGF0aCI6Ii81OTM5MTI3LzQxMDAxMDgwNS1mNzE2NTU5ZS04NmQzLTQzNTMtOTY0Ny0xZjEwMTg5MDkyMGIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTFUMDQ1NDU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9OGU4MmU2MDRjZmNiZGYzODcxMDIzOGQ4OWQ5YWI1ZDZhNWM0NTZlMzVlNjM0MDNiODE1MzZlZjY5ZTYxNjllYSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.i8dmR22qRuT3b7Th5h0PN_lWoa3Cnf_Q4Vs6lGDbEVw)
![image](https://private-user-images.githubusercontent.com/5939127/410010904-70cd5580-6e75-4943-8629-923be9173a5b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNDk5OTYsIm5iZiI6MTczOTI0OTY5NiwicGF0aCI6Ii81OTM5MTI3LzQxMDAxMDkwNC03MGNkNTU4MC02ZTc1LTQ5NDMtODYyOS05MjNiZTkxNzNhNWIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI1MDIxMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNTAyMTFUMDQ1NDU2WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ODU1MGUxOTYzZjNmM2U4ZDUxZmEzMTI0M2ExZTVlNWJjNDhlODU0NjVjMThjZjk2ZjIzZTY0YzczZThhMGU4NCZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.lNm-J4LDowjkfo2UtJSvC_NYu27fsmzZEG3huP7_Wow)
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.
Interesting! So, what change would I need to make to have an actual checkbox?
Description
Related Issue
Motivation and Context
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: