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

Removed old Component references from the Getting Started guide. #108

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

ioanalianabalas
Copy link
Contributor

Fixes BladeRunnerJS/brjs#1383 by removing old Component references from the Getting Started guide.

@andy-berry-dev
Copy link
Member

I know we wanted to remove old Component interface references as part of BladeRunnerJS/brjs#1383, but this makes the getting started guide more complicated. Getting started guides are meant to be straightforward. IMO either we need to simplify the interface or not use it at all in the getting started guide.

@ioanalianabalas
Copy link
Contributor Author

I think it is important to keep in mind that we want to teach people the proper way to do things. I agree that it is more complicated than it was, but I think it still remains pretty clear. In my opinion, if we still consider this to be at a too high level for the tutorial, we should try to simplify it. I would not remove it completely from the guide, because I do think that it is a feature that would be used and needs to be documented properly.

@dchambers
Copy link
Contributor

I think it is important to keep in mind that we want to teach people the proper way to do things.

Yes, I fully agree with this. Although the fact it's slightly more complex is a negative, telling people the wrong way to do things and then having to re-educate them later is a far bigger negative. In addition to that, advertising deprecated APIs to make our products appear simpler than they actually are is dishonest.

@andy-berry-dev
Copy link
Member

You're assuming everyone is going to be using these interfaces. CT users yes, but I can't see everyone that takes BRJS using them. BRJS as a toolkit provides the enforcement of feature separation and the bundling of assets, but as far as how you write your Blades it's up to the developer. Yes we should suggest how people should write apps and how the Component interface helps, but IMO this isn't something that should be used in the getting started guide.

@dchambers
Copy link
Contributor

You're assuming everyone is going to be using these interfaces. CT users yes, but I can't see everyone that takes BRJS using them.

Actually, CT is currently using the old Component interface, and not the BRJS one, and this is something I think we need to address since it's causing there to be a fork in libraries like 'presenter'. As for BRJS, then the only right way to do it is the way we've now shown, but the 'simpler' way you are advocating is using the old CT interface that is only still supported for backwards compatibility reasons, and which prevents some components from working since important events like attach will never be fired.

@andy-berry-dev
Copy link
Member

To summarise what we decided on:
We'll add a note to get the getting started guide explaining that while it looks more complicated and different from how you'd expect to add blades to the page it's a mechanism that we've found essential when apps get more complex and more blades are added. @dchambers will take a look at it.

dchambers added 2 commits June 3, 2015 08:46
…ince, although these are useful to have in our templates as they indicate the presence of unused parameters, within the documentation they just make things seem more complicated than they actually are.
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.

3 participants