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

docs: added table of contents and introduction document for Studio tool #553

Closed
wants to merge 46 commits into from

Conversation

Jagrutiti
Copy link

@Jagrutiti Jagrutiti commented Jan 29, 2023

Description

Added the following document for Studio tool for #552

  • Table of contents
  • Introduction

@netlify
Copy link

netlify bot commented Jan 29, 2023

Deploy Preview for modest-rosalind-098b67 ready!

Name Link
🔨 Latest commit c470434
🔍 Latest deploy log https://app.netlify.com/sites/modest-rosalind-098b67/deploys/660df33c0fcd370008c706de
😎 Deploy Preview https://deploy-preview-553--modest-rosalind-098b67.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@Jagrutiti Jagrutiti changed the title doc: added table of contents and introduction document for Studio tool docs: added table of contents and introduction document for Studio tool Jan 29, 2023
Copy link
Author

@Jagrutiti Jagrutiti left a comment

Choose a reason for hiding this comment

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

Hey @alequetzalli, @derberg , @Florence-Njeri,

I have added Table of Contents and Introduction document in this PR. (I used Generator documentation for guidance)

For Usage, I was unable to think of what content to start with.

Usage is not possible without explaining the Navigation Panel. What if I am not left with unique content for each document.

docs/README.md Show resolved Hide resolved
@quetzalliwrites
Copy link
Member

For Usage, I was unable to think of what content to start with.
Usage is not possible without explaining the Navigation Panel. What if I am not left with unique content for each document.

lol don't freak out yet @Jagrutiti ... this to me seems like a possibility for removing usage but keeping the other topics in the Table of Contents... thoughts, @magicmatatjahu?

Co-authored-by: Alejandra Quetzalli  <[email protected]>
docs/README.md Outdated Show resolved Hide resolved
@magicmatatjahu
Copy link
Member

magicmatatjahu commented Feb 13, 2023

@alequetzalli @Jagrutiti Sorry for such a delay! Yes, we can now remove Usage section and add it in the next PRs. Usage of Studio is hard to describe, because you can use it by CLI (start it), by studio.asyncapi.com and by docker - we should think if it's necessary to describe or not, but we can :)

@alequetzalli Should we merge that in this shape?

Copy link
Member

@magicmatatjahu magicmatatjahu left a comment

Choose a reason for hiding this comment

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

I added some suggestions :) Great work @Jagrutiti !

docs/navigation.md Outdated Show resolved Hide resolved
docs/navigation.md Outdated Show resolved Hide resolved
docs/navigation.md Outdated Show resolved Hide resolved
docs/navigation.md Outdated Show resolved Hide resolved
docs/navigation.md Outdated Show resolved Hide resolved
docs/navigation.md Outdated Show resolved Hide resolved
@Amzani
Copy link
Collaborator

Amzani commented Mar 26, 2024

/rtm

Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@quetzalliwrites
Copy link
Member

@Amzani did you accept my commmit suggestions? It doesn't look like it, thus blocking the merge from happening. :)

@Amzani Amzani dismissed stale reviews from KhudaDad414 and themself via 1a3d7d1 March 26, 2024 20:21
Copy link

sonarqubecloud bot commented Apr 4, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@KhudaDad414 KhudaDad414 requested a review from Amzani April 4, 2024 00:38
@KhudaDad414
Copy link
Member

@magicmatatjahu can't merge this PR without your approval. can you take a look?

Copy link

github-actions bot commented Aug 3, 2024

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 ❤️

@github-actions github-actions bot added the stale label Aug 3, 2024
@github-actions github-actions bot closed this Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants