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

feat: add vision, goals, and roadmap #189

Merged
merged 31 commits into from
Mar 11, 2021
Merged

Conversation

fmvilas
Copy link
Member

@fmvilas fmvilas commented Mar 1, 2021

Description

This adds a new page containing the description of the 5-year vision, goals, and roadmap.

  • Add paragraphs explaining that goals are there to serve the vision.
  • Add the roadmap.
  • Add ideas/solutions to the road map for those who are looking for more actionable items.
After it's merged:

@netlify
Copy link

netlify bot commented Mar 1, 2021

Deploy preview for asyncapi-website processing.

Building with commit 05ac3e3

https://app.netlify.com/sites/asyncapi-website/deploys/6049d2e7c0981f0007d052e2

@fmvilas fmvilas changed the title Add vision, goals, and roadmap feat: add vision, goals, and roadmap Mar 1, 2021
@fmvilas
Copy link
Member Author

fmvilas commented Mar 1, 2021

pages/roadmap.js Outdated Show resolved Hide resolved
pages/roadmap.js Outdated Show resolved Hide resolved
pages/roadmap.js Outdated Show resolved Hide resolved
@smoya
Copy link
Member

smoya commented Mar 1, 2021

The doc looks so great 🎉 💯 !!

It would be awesome if we can also provide some guidelines on how people can help to achieve the goals more specifically or rather what key questions shall we ask others and also ourselves whenever we add new features. A more specific version of "Is this really aligned with our goals"?.

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 great so far 💪🏼

@magicmatatjahu
Copy link
Member

@fmvilas Looking great, but I don't see any link from navigation to go to roadmap. Is it intentional?

@fmvilas
Copy link
Member Author

fmvilas commented Mar 2, 2021

@magicmatatjahu yes, it's an early version. I'll add it to the navigation later.

pages/roadmap.js Outdated Show resolved Hide resolved
@fmvilas
Copy link
Member Author

fmvilas commented Mar 5, 2021

I think we're aligned. Let me just add one more step. I think it's important to keep these "generic" outcomes. They're not generic, they're concrete. But not concrete things anyone can jump and do but instead concrete problems we want to solve.

The reason you're seeing it generic now is that:

  1. You're looking at it from a task description point of view. And like you, many people will look at it like this.
  2. It's missing one step in the middle. Usually called "Solution" or "Idea". So, for instance, User is able to focus only on business logic will get 3 actionable items: a. CLI to create AsyncAPI files interactively; b. Improve Generator so people don't have to worry about models; c. Create a framework that uses an AsyncAPI file as a config file and automatically does everything for you.

In this case, 2.b. will then be mapped to the features that are now there in black. I hope I'm making myself understandable here 😄 It should be easy to understand once you see it and still will be Github issues.

@derberg
Copy link
Member

derberg commented Mar 5, 2021

@fmvilas should we then be in rush to merge? wouldn't it be better if you just work on those descriptions and then we merge?

@fmvilas
Copy link
Member Author

fmvilas commented Mar 5, 2021

Yeah, let's hold it for now.

Copy link
Member

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

Looking great 💪

Only one comment, I would not show both asyncapi/shape-up-process#21 and asyncapi/shape-up-process#43. One is research, one is implementation (is it just a placeholder for now or?).

I would either rename the issues or just display asyncapi/shape-up-process#21.

@fmvilas
Copy link
Member Author

fmvilas commented Mar 5, 2021

@jonaslagoni I'd prefer to have the research there as well, to show the full story. It's part of the task in the end.

@fmvilas
Copy link
Member Author

fmvilas commented Mar 8, 2021

@derberg how about this way of visualizing the relationship now? https://deploy-preview-189--asyncapi-website.netlify.app/roadmap.

I'm thinking now:

  • Add a box explaining this is our road map but anyone can contribute and solve something any time.
  • Adding an icon with a question mark next to Solution and Feature tags to clarify their meaning.
  • Completing issues descriptions.
  • Record a video explaining the roadmap for those who don't like to read. (this may be another PR so it's not blocking)

@derberg
Copy link
Member

derberg commented Mar 8, 2021

@fmvilas

how about this way of visualizing the relationship now? https://deploy-preview-189--asyncapi-website.netlify.app/roadmap.

you mean the expand/collapse or something more? Collapse/expand is awesome! less noisy when you add other descriptions and can scale

Add a box explaining this is our road map but anyone can contribute and solve something any time.

yes, and make sure it gets into people's eyes 😄

Adding an icon with a question mark next to Solution and Feature tags to clarify their meaning.

do we even need this on the roadmap, I mean Solution or Feature, can't it be just a neutral color that means nothing? as more clarification is just in the issue? do we even need colors for Now, Later and Future? I mean, they are already grouped, the issues. There is no way item with label "Now" shows up under "Future" so there is not need to differentiate with color label? did you try doing it without those colors, maybe less colorful is more readable?

Completing issues descriptions.

🚀

Record a video explaining the roadmap for those who don't like to read. (this may be another PR so it's not blocking)

that would be amazing and yes, can be added later and embedded from youtube. Totally another PR

@fmvilas
Copy link
Member Author

fmvilas commented Mar 8, 2021

do we even need colors for Now, Later and Future? [..] maybe less colorful is more readable?

No, we don't but it improves readability. Try it yourself, remove the colors. It becomes very "schematic".

@derberg
Copy link
Member

derberg commented Mar 8, 2021

Screenshot 2021-03-08 at 17 25 19

yeap, hard to distinguish, but maybe just entire columns could be framed, have border color like green, etc?

nevertheless to many colors is too much, requires additional legend for colors. So even if you leave colors for now, later, future, then at least remove legend as it is not needed

@fmvilas
Copy link
Member Author

fmvilas commented Mar 8, 2021

but maybe just entire columns could be framed, have border color like green, etc?

That was my first design. It was horrible 😄

at least remove legend as it is not needed

I'd not remove the legend, it's especially useful in mobile where there are no columns. May be obvious for some but prefer to make it clearer.

@derberg
Copy link
Member

derberg commented Mar 8, 2021

will you at least resign from the Feature/Solution? 😄

@fmvilas
Copy link
Member Author

fmvilas commented Mar 8, 2021

will you at least resign from the Feature/Solution? 😄

What do you mean? I thought this was bringing more clarity to the road map. Or do you mean the colors?

@derberg
Copy link
Member

derberg commented Mar 9, 2021

Screenshot 2021-03-09 at 09 49 09

it is just too many details, feature or solution if both are on the same level

@fmvilas
Copy link
Member Author

fmvilas commented Mar 9, 2021

But they're not the same. For instance, a solution is "Create an event gateway". Features are what will make the creation of the gateway possible. If I put them on the same level, I'll be giving the wrong information.

@derberg
Copy link
Member

derberg commented Mar 9, 2021

oh wait, was it expandable yesterday? the solution? I don't think, so. Now when I see that feature is under solution, it is super clear. Sorry for the confusion and pointless discussion from my side.....I could wait to see it first

Screenshot 2021-03-09 at 10 02 11

@fmvilas
Copy link
Member Author

fmvilas commented Mar 10, 2021

@derberg I'm happy with the result now. I've finished adding descriptions to all the Outcomes and Solutions, except the ones below, that I want to check with you first:

Captura de pantalla 2021-03-10 a las 20 25 01

In any case, this is a living road map and it's never going to be done so I'd suggest we merge already.

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.

:shipit:

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.

7 participants