feat: add adopters section to case study page #2232

vishvamsinh28 · 2023-10-14T11:39:22Z

adoptors added

netlify · 2023-10-14T11:39:26Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`7f18339`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/658446689d687400088449e9
😎 Deploy Preview	https://deploy-preview-2232--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

github-actions · 2023-10-14T11:41:27Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	24
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://deploy-preview-2232--asyncapi-website.netlify.app/

derberg

Thanks a lot, you'll need to refactor a bit as we talk about Adopters and not Adoptors, so UI changes and all the naming updates must be done accordingly

regarding the yaml file with data, I would not differentiate between video and docs as there can also be just links to slides. So I suggest that resources is just an array of objects with title and link props

vishvamsinh28 · 2023-10-16T15:36:32Z

@derberg code updated!

derberg · 2023-10-18T07:36:42Z

.gitignore

@@ -7,6 +7,7 @@ node_modules
 out
 config/posts.json
 config/case-studies.json
+config/adoptors.json


adopters please

and remove adopters.json from this pr

derberg · 2023-10-18T07:36:53Z

config/adopters/adoptors.yml

@@ -0,0 +1,31 @@
+- companyName: Reiffeisen Bank


file should be called adopters

derberg · 2023-10-18T07:38:05Z

pages/casestudies/index.js

+            <Paragraph typeStyle="body-md" className="my-4 max-w-4xl">
+              Feel free to submit a pull request with information about how your company uses AsyncAPI. We know that
+              writing an official case study might be time consuming and requires too much internal paper work.
+              Let's make sure we can atleast capture a use case that is already a great learning information for the


Suggested change

Let's make sure we can atleast capture a use case that is already a great learning information for the

Let's make sure we can at least capture a use case that is already a great learning information for the

vishvamsinh28 · 2023-10-18T07:38:35Z

@derberg oh sorry i forgot to change the name of the files 😅. Is everything else perfect?

derberg · 2023-10-18T07:39:25Z

pages/casestudies/index.js

+              Check out how different companies use AsyncAPI and what problems they solve.
+            </Paragraph>
+            <Paragraph typeStyle="body-md" className="my-4 max-w-4xl">
+              Feel free to submit a pull request with information about how your company uses AsyncAPI. We know that


submit a pull request can you make it a link that points to config/adopters/adoptors.yml file, so people immediately know where to place the info

derberg · 2023-10-18T07:41:58Z

scripts/adopters/index.js

+
+const dirWithAdopters = 'config/adopters';
+module.exports = async function buildAdoptersList() {
+    let files = await readdir(dirWithAdopters);


adopters.yml is just a single file, and will be like this long term, so why we need code that reads all files from adopters dir. Maybe just remove adopters dir and add adopters.yml directory to config, and just read that one single file and transform to json

vishvamsinh28 · 2023-10-18T08:17:17Z

@derberg code updated! Should i add a line under "submit a pull request" ?

derberg · 2023-10-23T10:58:46Z

@vishvamsinh28 yes, make it visible as clickable link as it is not visible now

derberg · 2023-10-23T11:00:00Z

config/adopters/adopters.yml

@@ -0,0 +1 @@
+[{"companyName":"Reiffeisen Bank","useCase":"Continuous Integration and Continuous Delivery (CI/CD) pipeline based on GitOps to deploy a topology built on Async API definitions using a Kubernetes operator to an Apache Pulsar cluster.","resources":[{"title":"Video - From an AsyncAPI Definition to a Deployed Pulsar Topology Via GitOps","link":"https://www.youtube.com/watch?v=_MwzLZMwFN8"}]},{"companyName":"LEGO Group","useCase":"Broker management, where developers do not access the management console themselves, but rely on uploading AsyncAPI documents to a self service API that provisions access and topics specified in documents.","resources":[{"title":"Video - Documentation as Configuration for Management of Apache Pulsar","link":"https://www.youtube.com/watch?v=m8I0fYjx6Cc"}]},{"companyName":"LEGO Group","useCase":"Define, document and distribute event-driven APIs. Ensuring consistency and governance","resources":[{"title":"Video - Cross-Domain Events with AsyncAPI and AWS","link":"https://www.youtube.com/watch?v=qjarcJQVLOg"}]},{"companyName":"Bank of New Zealand","useCase":"Decentralized company-wide governance strategy for API. A self service for publishing APIs and docs.","resources":[{"title":"Video - Self-service Events & Decentralised Governance with AsyncAPI: A Real World Example","link":"https://www.confluent.io/events/kafka-summit-apac-2021/self-service-events-and-decentralised-governance-with-asyncapi-a-real-world/"}]},{"companyName":"Zora Robotics","useCase":"Documenting lot products public MQTT API and building a developers portal.","resources":[{"title":"Video - Buliding and managing an extensive API for Robotics and loT","link":"https://www.youtube.com/watch?v=yjHgT0n2BtA"},{"title":"Docs - Buliding and managing an extensive API for Robotics and loT","link":"https://docs.zorabots.be/dev-mqtt-docs/latest/index.html"}]}]


if this is always going to be a singe life, do we need adopters sub directory for it?

can you format it into multiple human readable, not one line string? and why it is not yml?

I have few more adopters

Company: Walmart Use Case: Managing a central API Hub for internal teams. Using AsyncAPI for events discoverability an visibility in a single place. AsyncAPI also enabled company-wide governance on asynchronous APIs. Resources: - Title: Video - Time For AsyncAPI Specification Link: https://www.youtube.com/watch?v=SxTpGRaNIPo Company: eBay Use Case: Enabling partners to build with eBay through asynchronous communication. Public AsyncAPI documents enable code generation and faster integration. It also enables governance and standardisation. Resources: - Title: Video - AsyncAPI 2.0: Enabling the Event-Driven World Link: https://www.youtube.com/watch?v=XCccEYMNX5g - Title: Article - AsyncAPI 2.0: Enabling the Event-Driven World Link: https://innovation.ebayinc.com/tech/engineering/asyncapi-2-0-enabling-the-event-driven-world/ - Title: Docs - Overview of Notification API with public AsyncAPI documents Link: https://developer.ebay.com/api-docs/commerce/notification/overview.html

derberg · 2023-10-23T11:03:42Z

scripts/adopters/index.js

+const { resolve } = require('path');
+
+module.exports = async function buildAdoptersList() {
+    let AdoptersList = [];


why do we still need an array?

derberg · 2023-10-25T16:37:40Z

scripts/adopters/index.js

+
+        await writeFile(
+            resolve(__dirname, '../../config', 'adopters.json'),
+            JSON.stringify([jsonContent])


instead of doing AdoptersList[0] in component, just refactor this to JSON.stringify(jsonContent) right?

vishvamsinh28 · 2023-10-25T16:50:56Z

@derberg updated the code

asyncapi-bot · 2023-12-07T18:25:54Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	41
🟢 Accessibility	98
🟢 Best practices	92
🟢 SEO	100
🔴 PWA	33

Lighthouse ran on https://deploy-preview-2232--asyncapi-website.netlify.app/

vishvamsinh28 · 2023-12-07T18:26:23Z

@akshatnema No, i haven't added tests to it yet

akshatnema · 2023-12-07T18:41:33Z

Adding do-not-merge label so that someone shouldn't accidentally merge this PR.

akshatnema · 2023-12-07T18:41:41Z

/dnm

derberg · 2023-12-11T11:59:37Z

@vishvamsinh28 you need some help?

vishvamsinh28 · 2023-12-11T15:13:07Z

@vishvamsinh28 you need some help?

@derberg Yes, i am getting some errors after writing tests

derberg · 2023-12-19T12:42:28Z

@vishvamsinh28 you do know that I cannot help as long as you do not write exactly what errors you're getting 😆

…into Extend#2135

derberg

LGTM
tests do what I expect them to do, iterate over data and make sure component renders them ❤️

@akshatnema wanna have a final look?

akshatnema · 2023-12-21T11:29:08Z

cypress/test/components/CaseStudyCard.cy.js

+
+  it('does not render anything when adopters array is empty', () => {
+    // Modify Casestudies component to pass an empty AdoptersList
+    mount(<Casestudies adopters={[]} />);


you haven't add any prop of adopters in CaseStudies component, how are you passing it to check that adopters should be empty?

you haven't add any prop of adopters in CaseStudies component, how are you passing it to check that adopters should be empty?

@akshatnema i was testing few things and forgot to remove it from the code 😅. i have updated the tests but it is still failing the test, i don't why it is happening

…into Extend#2135

derberg

❤️

akshatnema · 2023-12-21T14:11:30Z

/rtm

adoptors added

ccf5a55

vishvamsinh28 requested review from derberg, akshatnema, magicmatatjahu, Mayaleeeee and asyncapi-bot-eve as code owners October 14, 2023 11:39

derberg requested changes Oct 16, 2023

View reviewed changes

vishvamsinh28 changed the title ~~feat: adoptors added~~ feat: adopters added Oct 16, 2023

yaml and ui changes

fb17b2c

derberg reviewed Oct 18, 2023

View reviewed changes

config/adopters/adoptors.yml Outdated

@@ -0,0 +1,31 @@

- companyName: Reiffeisen Bank

Copy link

Member

derberg Oct 18, 2023

Choose a reason for hiding this comment

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

file should be called adopters

derberg reviewed Oct 18, 2023

View reviewed changes

code updated

531467d

derberg changed the title ~~feat: adopters added~~ feat: add adopters section to case study page Oct 23, 2023

derberg reviewed Oct 23, 2023

View reviewed changes

code and data updates

b0b538e

derberg reviewed Oct 25, 2023

View reviewed changes

code updates

417984c

path changes

87dabc5

derberg previously approved these changes Oct 30, 2023

View reviewed changes

Merge branch 'master' into Extend#2135

4f18ebb

Merge branch 'master' into Extend#2135

9ad35b5

asyncapi-bot added the do-not-merge label Dec 7, 2023

Merge branch 'master' into Extend#2135

590f863

vishvamsinh28 added 3 commits December 20, 2023 13:06

design updates

4232685

added tests

0953060

Merge branch 'Extend#2135' of https://github.com/vishvamsinh28/website …

ab21759

…into Extend#2135

vishvamsinh28 dismissed derberg’s stale review via ab21759 December 20, 2023 16:45

Merge branch 'master' into Extend#2135

4881f62

derberg previously approved these changes Dec 21, 2023

View reviewed changes

akshatnema reviewed Dec 21, 2023

View reviewed changes

vishvamsinh28 added 2 commits December 21, 2023 17:40

test updaates

283bcc6

Merge branch 'Extend#2135' of https://github.com/vishvamsinh28/website …

c14b98b

…into Extend#2135

vishvamsinh28 dismissed derberg’s stale review via c14b98b December 21, 2023 12:11

vishvamsinh28 added 2 commits December 21, 2023 17:44

test updates 2

5bf5f18

test updates 3

dde0876

derberg previously approved these changes Dec 21, 2023

View reviewed changes

correct pages/casestudies tests

7f18339

akshatnema dismissed derberg’s stale review via 7f18339 December 21, 2023 14:06

akshatnema approved these changes Dec 21, 2023

View reviewed changes

asyncapi-bot added the ready-to-merge label Dec 21, 2023

akshatnema removed the do-not-merge label Dec 21, 2023

asyncapi-bot merged commit 355d1a3 into asyncapi:master Dec 21, 2023
20 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add adopters section to case study page #2232

feat: add adopters section to case study page #2232

vishvamsinh28 commented Oct 14, 2023

netlify bot commented Oct 14, 2023 •

edited

Loading

github-actions bot commented Oct 14, 2023 •

edited

Loading

derberg left a comment

vishvamsinh28 commented Oct 16, 2023

derberg Oct 18, 2023

derberg Oct 18, 2023

derberg Oct 18, 2023

derberg Oct 18, 2023

vishvamsinh28 commented Oct 18, 2023 •

edited

Loading

derberg Oct 18, 2023

derberg Oct 18, 2023

vishvamsinh28 commented Oct 18, 2023

derberg commented Oct 23, 2023

derberg Oct 23, 2023

derberg Oct 23, 2023

derberg Oct 23, 2023

derberg Oct 25, 2023

vishvamsinh28 commented Oct 25, 2023

asyncapi-bot commented Dec 7, 2023 •

edited

Loading

vishvamsinh28 commented Dec 7, 2023

akshatnema commented Dec 7, 2023

akshatnema commented Dec 7, 2023

derberg commented Dec 11, 2023

vishvamsinh28 commented Dec 11, 2023

derberg commented Dec 19, 2023

derberg left a comment

akshatnema Dec 21, 2023

vishvamsinh28 Dec 21, 2023 •

edited

Loading

derberg left a comment

akshatnema commented Dec 21, 2023

	Let's make sure we can atleast capture a use case that is already a great learning information for the
	Let's make sure we can at least capture a use case that is already a great learning information for the

		@@ -0,0 +1 @@
		[{"companyName":"Reiffeisen Bank","useCase":"Continuous Integration and Continuous Delivery (CI/CD) pipeline based on GitOps to deploy a topology built on Async API definitions using a Kubernetes operator to an Apache Pulsar cluster.","resources":[{"title":"Video - From an AsyncAPI Definition to a Deployed Pulsar Topology Via GitOps","link":"https://www.youtube.com/watch?v=_MwzLZMwFN8"}]},{"companyName":"LEGO Group","useCase":"Broker management, where developers do not access the management console themselves, but rely on uploading AsyncAPI documents to a self service API that provisions access and topics specified in documents.","resources":[{"title":"Video - Documentation as Configuration for Management of Apache Pulsar","link":"https://www.youtube.com/watch?v=m8I0fYjx6Cc"}]},{"companyName":"LEGO Group","useCase":"Define, document and distribute event-driven APIs. Ensuring consistency and governance","resources":[{"title":"Video - Cross-Domain Events with AsyncAPI and AWS","link":"https://www.youtube.com/watch?v=qjarcJQVLOg"}]},{"companyName":"Bank of New Zealand","useCase":"Decentralized company-wide governance strategy for API. A self service for publishing APIs and docs.","resources":[{"title":"Video - Self-service Events & Decentralised Governance with AsyncAPI: A Real World Example","link":"https://www.confluent.io/events/kafka-summit-apac-2021/self-service-events-and-decentralised-governance-with-asyncapi-a-real-world/"}]},{"companyName":"Zora Robotics","useCase":"Documenting lot products public MQTT API and building a developers portal.","resources":[{"title":"Video - Buliding and managing an extensive API for Robotics and loT","link":"https://www.youtube.com/watch?v=yjHgT0n2BtA"},{"title":"Docs - Buliding and managing an extensive API for Robotics and loT","link":"https://docs.zorabots.be/dev-mqtt-docs/latest/index.html"}]}]

feat: add adopters section to case study page #2232

feat: add adopters section to case study page #2232

Conversation

vishvamsinh28 commented Oct 14, 2023

netlify bot commented Oct 14, 2023 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

github-actions bot commented Oct 14, 2023 • edited Loading

derberg left a comment

Choose a reason for hiding this comment

vishvamsinh28 commented Oct 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vishvamsinh28 commented Oct 18, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vishvamsinh28 commented Oct 18, 2023

derberg commented Oct 23, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vishvamsinh28 commented Oct 25, 2023

asyncapi-bot commented Dec 7, 2023 • edited Loading

vishvamsinh28 commented Dec 7, 2023

akshatnema commented Dec 7, 2023

akshatnema commented Dec 7, 2023

derberg commented Dec 11, 2023

vishvamsinh28 commented Dec 11, 2023

derberg commented Dec 19, 2023

derberg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vishvamsinh28 Dec 21, 2023 • edited Loading

Choose a reason for hiding this comment

derberg left a comment

Choose a reason for hiding this comment

akshatnema commented Dec 21, 2023

netlify bot commented Oct 14, 2023 •

edited

Loading

github-actions bot commented Oct 14, 2023 •

edited

Loading

vishvamsinh28 commented Oct 18, 2023 •

edited

Loading

asyncapi-bot commented Dec 7, 2023 •

edited

Loading

vishvamsinh28 Dec 21, 2023 •

edited

Loading