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: embedded a youtube video component #477

Closed
wants to merge 3 commits into from
Closed

docs: embedded a youtube video component #477

wants to merge 3 commits into from

Conversation

sambhavsaxena
Copy link
Contributor

@sambhavsaxena sambhavsaxena commented Nov 30, 2021

Description

  • Added an MDX YouTube component to the getting-started page of Docs section.
    Screenshot from 2021-11-30 16-41-11

  • The component embeds a YouTube video to the home of Docs section.

Related issue(s)
Fixes #408

@netlify
Copy link

netlify bot commented Nov 30, 2021

✔️ Deploy Preview for asyncapi-website ready!
Built without sensitive environment variables

🔨 Explore the source changes: 8a2cc72

🔍 Inspect the deploy log: https://app.netlify.com/sites/asyncapi-website/deploys/61a6c3fa0650850007330bc4

😎 Browse the preview: https://deploy-preview-477--asyncapi-website.netlify.app

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide 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.

@sambhavsaxena sambhavsaxena changed the title docs: Embedded a youtube video component docs: embedded a youtube video component Nov 30, 2021
@derberg
Copy link
Member

derberg commented Nov 30, 2021

@alequetzalli do you want to have a look as docs owner, any objection?
@boyney123 you reported an issue initially, all good from your side?

@alequetzalli alequetzalli self-requested a review December 1, 2021 00:39
@alequetzalli
Copy link
Member

alequetzalli commented Dec 1, 2021

@derberg I actually decided it makes sense to close this PR because:

  • We should not be adding a YT video to the Docs unless it aligns w/ page and our new IA content goals: This is a Postman-themed video that no doubt has great content, but it does not have a place in our Intro Docs section.
  • This PR is not in response to an issue that has been created and approved by community discussion to integrate this change into Docs. (sorry, as in.. Dave made this issue, but I was not even aware of it as Docs owner so you can see how this did not have the needed discussion .. "approval" if you will... to merit a PR w/ a video that hasn't been checked out by Docs)

@alequetzalli
Copy link
Member

alequetzalli commented Dec 1, 2021

@sambhavsaxena This video doesn't really align w/ our Docs, and in order to make a contribution to the Docs, we need to first create an issue that is tagged in the Docs Board here. 🙂

In this example, if you found a video that had content that was specifically in alignment w/ a page's content, you first need to create an issue to propose your change and new idea. 💡 🙂 This is actually part of our contribution guidelines as you can see more here.

In this case, an issue w/ an idea by @boyney123 was created, but I as Docs owner had no visibility on it and thus no actual community discussion was started to determine if that issue made sense to be "approved" for the Docs' intro section.

Under the current changes and upgrades coming to the Docs, I can't really approve that issue or this PR, @sambhavsaxena, because I don't want us adding videos without thought and careful planning to our Doc pages. Any interactive content and videos need to have an outline agenda that matches that Doc page specifically.

In addition, let me point you also to also read here and here, about our latest changes to our Docs' Information Architecture (IA), because it will help you get a better understanding and context on what content we want to add. ❤️

If you get more ideas or want to ask me more questions about Docs' contributions, just let me know! 😀👍🏽

@sambhavsaxena sambhavsaxena deleted the updated-getting-started branch December 1, 2021 02:48
@sambhavsaxena
Copy link
Contributor Author

Not a problem @alequetzalli, I'll look for other issues. Thanks for consideration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

doc: Adding video to "Getting Started" section
3 participants