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

refactor: add sidebar and render examples #291

Merged

Conversation

magicmatatjahu
Copy link
Member

@magicmatatjahu magicmatatjahu commented Apr 6, 2021

Description

Changes proposed in this pull request:

As in previous PRs, this only focus on code, not styling - it will be done in asyncapi/shape-up-process#86

  • Add Sidebar component with navigation like in HTML-Template with sidebarOrganization logic.
  • Render examples for messages.

Examples:

image

Related issue(s)
Part of asyncapi/shape-up-process#87
See also (fix) asyncapi/html-template#15

@magicmatatjahu magicmatatjahu added area/library Related to all activities around Library package enhancement New feature or request labels Apr 7, 2021
@magicmatatjahu magicmatatjahu marked this pull request as ready for review April 7, 2021 07:29
@magicmatatjahu magicmatatjahu requested a review from derberg April 7, 2021 07:29
@derberg
Copy link
Member

derberg commented Apr 7, 2021

@magicmatatjahu oh 2 features in one pr 😅

  • dummy spec should always be in sync with the one in generator, avoided having custom copy and modify the original file
  • some code and tests were remove, new code showed up, for examples, and it is not tested
  • screen shot in description shows the text is not wrapped and overlaps main content

@magicmatatjahu
Copy link
Member Author

@derberg Thanks for review! Hah 😅 Yes 2 features, but one missed in previous PRs with examples for messages and one totally new in component with sidebar. This is last PR with "new" things, next will be focused on styling.

dummy spec should always be in sync with the one in generator, avoided having custom copy and modify the original file

I removed in last commit changes from dummy.yaml, but I had to check if everything works with sidebarOrganization logic like in HTML-Template - dummy spec hasn't appropriate data for that.

some code and tests were remove, new code showed up, for examples, and it is not tested

I added tests, sorry 😅

screen shot in description shows the text is not wrapped and overlaps main content

Yep, I know, this PR (like previous) only focus on code and as you see there are 600 changed LOC. Next PRs will be focused on styling. I wanna split styling to 3 PRs: Info + Servers, Operations + Messages, Sidebar + missed parts.

Could you look again? Thanks from the mountain! 🤣

@sonarqubecloud
Copy link

sonarqubecloud bot commented Apr 7, 2021

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@derberg
Copy link
Member

derberg commented Apr 7, 2021

I removed in last commit changes from dummy.yaml, but I had to check if everything works with sidebarOrganization logic like in HTML-Template - dummy spec hasn't appropriate data for that.

PR's are welcome 😄

@magicmatatjahu
Copy link
Member Author

@derberg Thanks!

@magicmatatjahu magicmatatjahu merged commit ba91b1e into asyncapi:unify-component Apr 7, 2021
@magicmatatjahu magicmatatjahu deleted the unify-sidebar branch April 7, 2021 12:54
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.21.0-next.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/library Related to all activities around Library package enhancement New feature or request released on @next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants