docs: tutorial - validate asyncapi document with cli #1341

Aysha-py · 2023-02-14T10:06:55Z

Description

Added an Introduction and background context content for the file cli-documentation-validation.md

Related issue(s)
Fixes #1094

…on using CLI

netlify · 2023-02-14T10:07:01Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`9b96842`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/6407e88ae36c7500086ac2eb
😎 Deploy Preview	https://deploy-preview-1341--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

…on using CLI

github-actions · 2023-02-14T10:09:37Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	57
🟠 Accessibility	88
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://deploy-preview-1341--asyncapi-website.netlify.app/

octonawish-akcodes · 2023-02-14T10:10:40Z

In your PR title use "added" instead of "Added", Bot has commented about the same :)
The PR title should start with a small letter.

quetzalliwrites · 2023-02-22T02:59:17Z

pages/docs/tutorials/cli-documantation-validation.md

+AsyncAPI document enables people or machines communicating with one another to comprehend the capabilities of an event-driven API without requiring access to the source code, documentation, or network traffic inspection.
+The document allows developers to define the structure of their API, the format of the API, the events to which consumers can subscribe, and the response they receive when these events are triggered or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.
+
+## Installation Guide


hey! where is the tutorial? 😂 Please steps showing how to validate an AsyncAPI document with the CLI.

also, you can find the install instructions for AsyncAPI CLI in it's repo: https://github.com/asyncapi/cli/blob/master/docs/installation.md

that said, you should prob use our fragment that was created exactly for this: https://github.com/asyncapi/website/blob/master/assets/docs/fragments/cli-installation.md

You can add that fragment with the following snippet...

import CliInstallation from '../../../assets/docs/fragments/cli-installation.md' <CliInstallation/>

The tutorial will be included soon. I like to get feedback as I work on the documentation bit by bit to avoid going off track. Thank you for the feedback and assistance @alequetzalli

github-actions · 2023-07-07T00:22:33Z

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

AnimeshKumar923

Review requested @alequetzalli @Aysha-py

AnimeshKumar923 · 2023-07-07T16:05:27Z

pages/docs/tutorials/cli-documantation-validation.md

@@ -0,0 +1,17 @@
+---
+title: 'Validate AsyncApi documents with CLI commands'
+description: 'This tutorial will teach you how to validate AsynApi document using CLI commands'


Suggested change

description: 'This tutorial will teach you how to validate AsynApi document using CLI commands'

description: 'This tutorial will teach you how to validate AsyncAPI document using CLI commands'

AnimeshKumar923 · 2023-07-07T16:06:58Z

pages/docs/tutorials/cli-documantation-validation.md

@@ -0,0 +1,17 @@
+---
+title: 'Validate AsyncApi documents with CLI commands'


Suggested change

title: 'Validate AsyncApi documents with CLI commands'

title: 'Validate AsyncAPI documents with CLI commands'

AnimeshKumar923 · 2023-07-07T16:08:54Z

pages/docs/tutorials/cli-documantation-validation.md

+
+## Background context
+
+An AsyncAPI document is a file that defines and describes the various components of a message-based or event-driven API. Event-driven APIs are a type of asynchronous API that allows consumers to subscribe to events of interest. It adheres to an architecture in which events are fired or triggered. These triggers occur when a producer detects a state change caused by a user's device or an action taken by the user. The producer is an application that sense state changes and produces these changes as messages.


Suggested change

An AsyncAPI document is a file that defines and describes the various components of a message-based or event-driven API. Event-driven APIs are a type of asynchronous API that allows consumers to subscribe to events of interest. It adheres to an architecture in which events are fired or triggered. These triggers occur when a producer detects a state change caused by a user's device or an action taken by the user. The producer is an application that sense state changes and produces these changes as messages.

An AsyncAPI document is a file that defines and describes the various components of a message-based or event-driven API. Event-driven APIs are a type of asynchronous API that allows consumers to subscribe to events of interest. It adheres to an architecture in which events are fired or triggered. These triggers occur when a producer detects a state change caused by a user's device or an action taken by the user. The producer is an application that senses state changes and produces these changes as messages.

AnimeshKumar923 · 2023-07-07T16:10:58Z

pages/docs/tutorials/cli-documantation-validation.md

+An AsyncAPI document is a file that defines and describes the various components of a message-based or event-driven API. Event-driven APIs are a type of asynchronous API that allows consumers to subscribe to events of interest. It adheres to an architecture in which events are fired or triggered. These triggers occur when a producer detects a state change caused by a user's device or an action taken by the user. The producer is an application that sense state changes and produces these changes as messages.
+
+AsyncAPI document enables people or machines communicating with one another to comprehend the capabilities of an event-driven API without requiring access to the source code, documentation, or network traffic inspection.
+The document allows developers to define the structure of their API, the format of the API, the events to which consumers can subscribe, and the response they receive when these events are triggered or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.


Suggested change

The document allows developers to define the structure of their API, the format of the API, the events to which consumers can subscribe, and the response they receive when these events are triggered or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.

The document allows developers to define the structure of their API, the format of their API, the events to which consumers can subscribe, and the response they receive when these events are triggered, or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.

their should be better as it has been just used before

represented as JSON objects that follow the JSON that follow JSON format? <- Is this correct?

@AnimeshKumar923, yes, it is. I was working on this issue, but I got confused with the method to validate AsyncAPI documents using the CLI.

However, I have conducted research that helped me understand the Command Line Interface, and I just want to confirm with @alequetzalli if I can still continue to work on this issue.

AnimeshKumar923 · 2024-01-07T06:35:20Z

any updates on this @Aysha-py?
cc: @alequetzalli

sambhavgupta0705 · 2024-02-28T02:43:10Z

@Aysha-py any update???

quetzalliwrites · 2024-03-06T04:41:36Z

There is not need to review this draft PR because the author never completed her work. There is no tutorial steps or code snippets added. As it has been a year since the author left this incomplete, closing.

docs: Added Introduction and background context for AsyncAPI validati…

e47510a

…on using CLI

Aysha-py requested review from quetzalliwrites and asyncapi-bot-eve as code owners February 14, 2023 10:06

docs: added Introduction and background context for AsyncAPI validati…

5d860d8

…on using CLI

Merge branch 'master' into validation-using-cli

3905b8c

Aysha-py changed the title ~~docs: Added Introduction and background context for AsyncAPI validati…~~ docs: added Introduction and background context for AsyncAPI validati… Feb 14, 2023

Merge branch 'master' into validation-using-cli

374ab3f

quetzalliwrites reviewed Feb 22, 2023

View reviewed changes

quetzalliwrites changed the title ~~docs: added Introduction and background context for AsyncAPI validati…~~ docs: tutorial - validate asyncapi document with cli Feb 22, 2023

Merge branch 'master' into validation-using-cli

e373844

quetzalliwrites mentioned this pull request Feb 28, 2023

docs: cli validation tutorial steps #1370

Closed

Merge branch 'master' into validation-using-cli

9b96842

github-actions bot added the stale label Jul 7, 2023

AnimeshKumar923 reviewed Jul 7, 2023

View reviewed changes

github-actions bot removed the stale label Jul 8, 2023

quetzalliwrites closed this Mar 6, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: tutorial - validate asyncapi document with cli #1341

docs: tutorial - validate asyncapi document with cli #1341

Aysha-py commented Feb 14, 2023

netlify bot commented Feb 14, 2023 •

edited

Loading

github-actions bot commented Feb 14, 2023 •

edited

Loading

octonawish-akcodes commented Feb 14, 2023 •

edited

Loading

quetzalliwrites Feb 22, 2023

Aysha-py Feb 25, 2023

github-actions bot commented Jul 7, 2023

AnimeshKumar923 left a comment

AnimeshKumar923 Jul 7, 2023

AnimeshKumar923 Jul 7, 2023

AnimeshKumar923 Jul 7, 2023

AnimeshKumar923 Jul 7, 2023

Aysha-py Jul 11, 2023

AnimeshKumar923 commented Jan 7, 2024

sambhavgupta0705 commented Feb 28, 2024

quetzalliwrites commented Mar 6, 2024

	description: 'This tutorial will teach you how to validate AsynApi document using CLI commands'
	description: 'This tutorial will teach you how to validate AsyncAPI document using CLI commands'

		@@ -0,0 +1,17 @@
		---
		title: 'Validate AsyncApi documents with CLI commands'


		## Background context

		An AsyncAPI document is a file that defines and describes the various components of a message-based or event-driven API. Event-driven APIs are a type of asynchronous API that allows consumers to subscribe to events of interest. It adheres to an architecture in which events are fired or triggered. These triggers occur when a producer detects a state change caused by a user's device or an action taken by the user. The producer is an application that sense state changes and produces these changes as messages.

	The document allows developers to define the structure of their API, the format of the API, the events to which consumers can subscribe, and the response they receive when these events are triggered or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.
	The document allows developers to define the structure of their API, the format of their API, the events to which consumers can subscribe, and the response they receive when these events are triggered, or an action is taken. AsyncAPI documents are represented as JSON objects that follow the JSON.

docs: tutorial - validate asyncapi document with cli #1341

docs: tutorial - validate asyncapi document with cli #1341

Conversation

Aysha-py commented Feb 14, 2023

netlify bot commented Feb 14, 2023 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

github-actions bot commented Feb 14, 2023 • edited Loading

octonawish-akcodes commented Feb 14, 2023 • edited Loading

quetzalliwrites Feb 22, 2023

Choose a reason for hiding this comment

Aysha-py Feb 25, 2023

Choose a reason for hiding this comment

github-actions bot commented Jul 7, 2023

AnimeshKumar923 left a comment

Choose a reason for hiding this comment

AnimeshKumar923 Jul 7, 2023

Choose a reason for hiding this comment

AnimeshKumar923 Jul 7, 2023

Choose a reason for hiding this comment

AnimeshKumar923 Jul 7, 2023

Choose a reason for hiding this comment

AnimeshKumar923 Jul 7, 2023

Choose a reason for hiding this comment

Aysha-py Jul 11, 2023

Choose a reason for hiding this comment

AnimeshKumar923 commented Jan 7, 2024

sambhavgupta0705 commented Feb 28, 2024

quetzalliwrites commented Mar 6, 2024

netlify bot commented Feb 14, 2023 •

edited

Loading

github-actions bot commented Feb 14, 2023 •

edited

Loading

octonawish-akcodes commented Feb 14, 2023 •

edited

Loading