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

submission-review-updates #186

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Conversation

nimithajalal
Copy link
Collaborator

@nimithajalal nimithajalal commented Dec 9, 2024

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@nimithajalal nimithajalal requested a review from undavide December 9, 2024 12:12
Copy link
Collaborator

@undavide undavide left a 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",
Copy link
Collaborator

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"?

Copy link
Collaborator Author

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:
Copy link
Collaborator

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
 - ...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Let me check this.

Comment on lines +14 to +18
# Overview

This section provides a set of guidelines to help you in submitting your integrtion for review.

## Submission guidelines
Copy link
Collaborator

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
Copy link
Collaborator

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
Copy link
Collaborator

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 #

Comment on lines +38 to +39
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.
Copy link
Collaborator

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.

Copy link
Collaborator Author

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.

Comment on lines +14 to +18
# Overview

This guides helps you review the test cases before you submit your integration for review.

## Review Test Cases
Copy link
Collaborator

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.
Copy link
Collaborator

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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

image

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 image

Copy link
Collaborator Author

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?

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