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]: add Studio docs in TOOLS content bucket #552

Closed
1 task done
quetzalliwrites opened this issue Jan 27, 2023 · 7 comments
Closed
1 task done

[📑 Docs]: add Studio docs in TOOLS content bucket #552

quetzalliwrites opened this issue Jan 27, 2023 · 7 comments

Comments

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Jan 27, 2023

What Dev Docs changes are you proposing?

It's time to add Studio docs to AsyncAPI Docs. To do this, let's first update the documentation inside the actual studio repo, and then we'll automate copying over the new docs into the actual website.

NOTE: Questions about this process should be asked to @derberg, but @Florence-Njeri are most likely able also to help since she did the same automation for the Generator Docs she and pratik wrote during 2022 GSoD

Table of contents for new Studio docs

  • Introduction
  • Usage
  • Navigation
  • Editor
  • HTML Preview
  • Blocks visualizer
  • Studio Settings

File names for new Studio Docs

Create individual files for EACH topic outlined in the table of contents. You should have 7 new files for Studio.

Ex: asyncapi.com/docs/tools/studio/introduction

And your file in this example would be: introduction.md

cc @Jagrutiti @magicmatatjahu

Code of Conduct

  • I agree to follow this project's Code of Conduct
@github-actions
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@github-actions
Copy link

This issue 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 issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue 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 issue 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 May 29, 2023
@Jagrutiti
Copy link

This issue awaits review.

cc: @alequetzalli

@github-actions github-actions bot removed the stale label May 30, 2023
Copy link
Member Author

thanks for the ping, let me double check this week :)

@github-actions
Copy link

This issue 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 issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue 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 issue 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 Sep 29, 2023
@Jagrutiti
Copy link

I would like to continue working on this PR once my mentor finds time.

@github-actions github-actions bot removed the stale label Oct 2, 2023
Copy link

This issue 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 issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue 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 issue 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 Jan 31, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants