ISS-120468: Update documentation for the marketplace related commands #95

MhcVintar · 2024-09-25T13:22:27Z

Added documentation regarding marketplace listings.

https://app.devrev.ai/devrev/works/ISS-120468

Added documentation regarding marketplace listings. https://app.devrev.ai/devrev/works/ISS-120468

github-actions · 2024-09-25T13:24:04Z

Published docs preview URL: https://devrev-preview-e09bfb15-d3eb-45e0-8ebd-7a920ca281d9.docs.buildwithfern.com

fern/docs/pages/references/marketplace-listings.mdx

github-actions · 2024-09-25T16:32:41Z

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes. For details, visit the Analytics Page.

For questions or feedback, please email [email protected].

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

EkLine

🚫 [EkLine] _{reported by reviewdog 🐶}

Prefer English terms over Latin abbreviations. Use 'for example' instead of 'e.g.'. (EK00026)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 83 in 48960fc

properties (e.g. name, description, icon, etc.).

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 87 in 48960fc

    
           To create a new marketplace listing, run the following command, which will start a __wizard__ to guide you through the

📝 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 97 in 48960fc

    
           state), we can modify the listing by creating a new submission. First we have to create a submission which we can later

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 101 in 48960fc

    
           To create a new submission for an existing marketplace listing, run the following command, which will start a __wizard__

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 111 in 48960fc

    
           Once a submission has been created, it can be updated by running the following command, which will start a __wizard__ to

📝 [EkLine] _{reported by reviewdog 🐶}

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 120 in 48960fc

    
           The newly created marketplace submission is in the `draft` state. In order to publish it, we first have to transition it

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 121 in 48960fc

    
           to`waiting_for_review` state. This can be done by running the following command, which will start a __wizard__ to guide

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 129 in 48960fc

    
           While in review, the state of the submission is `in_review`. Once it is reviewed, the state will be changed to either

📝 [EkLine] _{reported by reviewdog 🐶}

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 137 in 48960fc

    
           If the submission was rejected, we can transition it back to `draft` state and modify it to satisfy the requirements.

📝 [EkLine] _{reported by reviewdog 🐶}

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 138 in 48960fc

    
           Once the submission is updated, we can transition it back to `waiting_for_review` state to be reviewed again.

📝 [EkLine] _{reported by reviewdog 🐶}

Suggestions:

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 140 in 48960fc

    
           If the submission was approved, we can publish it using the following command, which will start a __wizard__ to guide

📝 [EkLine] _{reported by reviewdog 🐶}

Avoid using 'we' as it can come off as patronizing. For example, write 'The configuration is complete' rather than 'We are now done with the configuration.' (EK81039)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 147 in 48960fc

    
           To make sure that marketplace item was published we can retrieve it using its ID:

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 157 in 48960fc

    
           the `draft` or `rejected` state. You can delete a submission using the following command, which will start a __wizard__

📝 [EkLine] _{reported by reviewdog 🐶}

Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 167 in 48960fc

    
           Once a new version for a marketplace-item is published, the respective Snap-Ins will be auto-upgraded to the latest

🚫 [EkLine] _{reported by reviewdog 🐶}

Confirm the link. The URL 'https://github.com/devrev/snap-in-docs/blob/main/references/cli.md' seems inaccessible with error code 404. It might be incorrect or improperly formatted. (EK20001)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 71 in 48960fc

    
           guide [visit here](https://github.com/devrev/snap-in-docs/blob/main/references/cli.md).

🚫 [EkLine] _{reported by reviewdog 🐶}

Confirm the link. The URL 'https://github.com/devrev/snap-in-docs/blob/main/start.md' seems inaccessible with error code 404. It might be incorrect or improperly formatted. (EK20001)

fern-api-docs/fern/docs/pages/references/marketplace-listings.mdx

Line 77 in 48960fc

    
           Snap-Ins, [follow this guide here](https://github.com/devrev/snap-in-docs/blob/main/start.md), to create your first

fern/docs/pages/references/marketplace-listings.mdx

bc-devrev · 2024-09-25T16:43:58Z

Also address comments from EkLine.

github-actions · 2024-09-26T11:38:18Z

Published docs preview URL: https://devrev-preview-d1cd921f-94a4-4384-9856-d55ee8128409.docs.buildwithfern.com

github-actions · 2024-09-26T11:43:54Z

Published docs preview URL: https://devrev-preview-3e7a02cb-aa77-48a0-b235-6aed00f60caa.docs.buildwithfern.com

github-actions · 2024-09-27T05:11:34Z

Published docs preview URL: https://devrev-preview-65ef9da5-d0d7-4cc1-94ba-d3ddde4e2e55.docs.buildwithfern.com

… into ISS-120468-marketplace-listings

github-actions · 2024-09-27T05:16:37Z

Published docs preview URL: https://devrev-preview-9e039dc0-c3b2-4d6a-b5f9-4566c4884da5.docs.buildwithfern.com

fern/docs/pages/marketplace-listings.mdx

github-actions · 2024-09-30T09:46:41Z

Published docs preview URL: https://devrev-preview-fe09c0d2-9f1c-4f4d-9dde-ac66beec64e5.docs.buildwithfern.com

bc-devrev

Two main things to fix before merging:

Put states in italics, not code phrase.
Don't use "we"; use "you" instead.

fern/docs/pages/marketplace-listings.mdx

github-actions · 2024-10-01T08:20:32Z

Published docs preview URL: https://devrev-preview-cbc5314a-f64d-4b9c-a251-139686bc6f7a.docs.buildwithfern.com

ISS-120468: Update documentation for the marketplace related commands

f6b0f3f

Added documentation regarding marketplace listings. https://app.devrev.ai/devrev/works/ISS-120468

MhcVintar requested a review from a team as a code owner September 25, 2024 13:22

MhcVintar requested review from kosenina and Gokul-Ks September 25, 2024 13:22

forgot to update the public.yml file

48960fc

kosenina reviewed Sep 25, 2024

View reviewed changes

bc-devrev added the No EkLine Skip EkLine automated QA label Sep 25, 2024

github-actions bot reviewed Sep 25, 2024

View reviewed changes

bc-devrev requested changes Sep 25, 2024

View reviewed changes

resolved comments

32efb15

nit

e0a14ad

MhcVintar requested review from bc-devrev and kosenina September 27, 2024 05:08

Merge branch 'main' into ISS-120468-marketplace-listings

dbba795

MhcVintar added 2 commits September 27, 2024 07:15

nit

7053d58

Merge remote-tracking branch 'origin/ISS-120468-marketplace-listings'…

409972b

… into ISS-120468-marketplace-listings

kosenina reviewed Sep 30, 2024

View reviewed changes

MhcVintar added 2 commits September 30, 2024 11:43

resolved comments

186ed18

forgot to add pictures

7754362

MhcVintar requested a review from kosenina September 30, 2024 09:48

kosenina approved these changes Sep 30, 2024

View reviewed changes

bc-devrev approved these changes Sep 30, 2024

View reviewed changes

resolved comments

69b841c

MhcVintar merged commit 5d7f984 into main Oct 1, 2024
2 checks passed

MhcVintar deleted the ISS-120468-marketplace-listings branch October 1, 2024 08:33

ISS-120468: Update documentation for the marketplace related commands #95

ISS-120468: Update documentation for the marketplace related commands #95

Uh oh!

Conversation

MhcVintar commented Sep 25, 2024

Uh oh!

github-actions bot commented Sep 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 25, 2024

🌟 EkLine Reviewer

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bc-devrev commented Sep 25, 2024

Uh oh!

github-actions bot commented Sep 26, 2024

Uh oh!

github-actions bot commented Sep 26, 2024

Uh oh!

github-actions bot commented Sep 27, 2024

Uh oh!

github-actions bot commented Sep 27, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 30, 2024

Uh oh!

bc-devrev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Oct 1, 2024

Uh oh!

Uh oh!

Uh oh!