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: unify documentation #302

Merged
merged 7 commits into from
Apr 20, 2021

Conversation

magicmatatjahu
Copy link
Member

Description

Changes proposed in this pull request:

  • Update main Readme.md
  • Update License and authors :trollface:
  • Move instruction of using web-component to ./docs/usage/web-component.md document.
  • Move instruction of using web-component in Angular to ./docs/usage/angular.md document.
  • Describe how to use the component in NextJS app in ./docs/usage/nextjs.md document.
  • Mention about esm, cjs and umd modules.

Related issue(s)
Part of asyncapi/shape-up-process#83

@magicmatatjahu magicmatatjahu added the area/documentation Related to all activities around documentation label Apr 19, 2021
@magicmatatjahu magicmatatjahu marked this pull request as ready for review April 19, 2021 10:18
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

looking on the change, IMHO we should release it as 1.0.0-rc.1

there are breaking changes that will cause issues to users if they just automatically bump. Component is changing a lot and we should clearly indicate that. This will also enable us to ship something that is not final and get feedback from current users.

We also need a migration guide, a short list of things that users need to do to switch to this release candidate. Best if it is published under the releasae

README.md Outdated Show resolved Hide resolved
docs/configuration/config-modification.md Outdated Show resolved Hide resolved
docs/development/guide.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
docs/usage/web-component.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@magicmatatjahu
Copy link
Member Author

magicmatatjahu commented Apr 19, 2021

@derberg Thanks for review!

looking on the change, IMHO we should release it as 1.0.0-rc.1

there are breaking changes that will cause issues to users if they just automatically bump. Component is changing a lot and we should clearly indicate that. This will also enable us to ship something that is not final and get feedback from current users.

I don't agree with this 1.0.0-rc.1. It should be released as 0.24.0 (with 0.23.0 where we fix all security issues in old version). Maybe the component has changed a lot, mainly the styling, but I don't think that's a reason to start with 1.0.0 (even rc). We still have 0.X.X so users should be prepared for breaking change.

We also need a migration guide, a short list of things that users need to do...

Sure :) I will remember about that.

@fmvilas What do you think about release?

README.md Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Apr 20, 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

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

I approve. Topic of release is not blocking for this PR imho. Just open another issue or simply make a note that in a final PR we need to discuss the release type and migration guide

@magicmatatjahu
Copy link
Member Author

@derberg Thanks! I will add note in final PR.

@magicmatatjahu magicmatatjahu merged commit 99969ac into asyncapi:unify-component Apr 20, 2021
@magicmatatjahu magicmatatjahu deleted the unify-readme branch April 20, 2021 08:39
@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/documentation Related to all activities around documentation released on @next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants