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]: import Glee docs under tools folder #2003

Closed
1 task done
AnimeshKumar923 opened this issue Jul 26, 2023 · 8 comments
Closed
1 task done

[📑 Docs]: import Glee docs under tools folder #2003

AnimeshKumar923 opened this issue Jul 26, 2023 · 8 comments
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers stale

Comments

@AnimeshKumar923
Copy link
Contributor

AnimeshKumar923 commented Jul 26, 2023

What Dev Docs changes are you proposing?

  • To help setup the workflow from Create GitHub Action to Render Docs into AsyncAPI Website Pages glee#481, we need to import the existing docs. Also, we need to add the weights and categorization to match same as the existing docs format.

  • Sample format: tutorials section. We can see that there is the sub-categorization of docs which is present inside the getting-started folder and how it relates to its parents.

  • Make a separate branch and do your work on that branch only. Don't make changes to the master branch.

  • Follow this guide before working on this issue.

Tasks

  • Create glee folder under website/pages/docs/tools/glee (I'm assuming Glee falls under tools section, please correct me if I'm wrong)
  • Copy reference folder from here and paste it inside glee folder.
  • Inside reference folder, there are three sub-folders namely, classes, interfaces and modules. In each file under the three sub-folders, we need to add a parent child relation similar to this.
    cc: @alequetzalli @thulieblack

Code of Conduct

  • I agree to follow this project's Code of Conduct
@AnimeshKumar923
Copy link
Contributor Author

/gfi docs

@asyncapi-bot asyncapi-bot added area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. good first issue Good for newcomers labels Jul 26, 2023
@AnimeshKumar923
Copy link
Contributor Author

what are the docs to import first as to get the workflow started?
cc: @KhudaDad414 @Souvikns @afzal442

@derberg
Copy link
Member

derberg commented Jul 27, 2023

to start pushing Glee or any other docs to website, there is nothing that must be done in the website

you need automation in glee, like:

the only thing that is not there in examples, is something that was added later, a config file for Edit button. So the automation you add, should also edit https://github.com/asyncapi/website/blob/master/config/edit-page-config.json and add your repo there

@AnimeshKumar923
Copy link
Contributor Author

AnimeshKumar923 commented Jul 27, 2023

the only thing that is not there in examples, is something that was added later, a config file for Edit button. So the automation you add, should also edit https://github.com/asyncapi/website/blob/master/config/edit-page-config.json and add your repo there

@derberg can I add this manually? or do I have to use automation/script?

Edit button.

Are you talking about this Edit button?
Screenshot from 2023-07-27 21-07-56

Copy link
Member

derberg commented Jul 31, 2023

Are you talking about this Edit button?

the intention is that this edit button, if possible, is done automatically by the integration script, this is why we have it in JSON file.

@AnimeshKumar923
Copy link
Contributor Author

Are you talking about this Edit button?

the intention is that this edit button, if possible, is done automatically by the integration script, this is why we have it in JSON file.

Okay. Let me figure it out then...

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 Nov 29, 2023
@AnimeshKumar923
Copy link
Contributor Author

resolved with asyncapi/glee#548

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs good first issue Good for newcomers stale
Projects
None yet
Development

No branches or pull requests

3 participants