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

What needs to be done for initial release #1

Closed
AntJanus opened this issue Jun 13, 2016 · 19 comments
Closed

What needs to be done for initial release #1

AntJanus opened this issue Jun 13, 2016 · 19 comments

Comments

@AntJanus
Copy link
Contributor

AntJanus commented Jun 13, 2016

We need to release angular-base to NPM but before that gets done, there is a lot of work to do, mainly having to do with other open source projects related to Foundation for Apps, and branding as well as deciding on the structure of the leadership behind this fork.

@AntJanus AntJanus changed the title What needs to be done What needs to be done for initial release Jun 13, 2016
@soumak77
Copy link
Contributor

It would be a good idea to continue with the decoupling of the framework that was started with https://github.com/zurb/front-router and https://github.com/zurb/motion-ui. This would help move in the direction of enabling other front end frameworks. This may not be something needed for the initial release, but should be done sooner than later.

@AntJanus
Copy link
Contributor Author

AntJanus commented Jun 13, 2016

To dos that I can think of:

Secondary release:

@soumak77
Copy link
Contributor

For new documentation needs to live somewhere as well, we can use https://pages.github.com. I've never personally used it, but seems easy enough and this way we don't need an alternate hosting site.

@mattgrande
Copy link

Does this need a CLI for v1? I think we could live without it, personally.

Agreed that github pages is a good solution for documentation.

@soumak77
Copy link
Contributor

Yeah the CLI is really just a few basic commands. I would prefer to not have to maintain it in this framework as it was designed specifically for the suite of foundation frameworks. If we only need to support the one framework, we can integrate the commands into npm scripts or gulp tasks.

@tolyo
Copy link
Contributor

tolyo commented Jun 13, 2016

The CLI is an overkill as its basically a wrapper around npm and a build tool.
We will need a second repo for angular-base-website.

@soumak77
Copy link
Contributor

I ran the auto generator to produce a template github pages website: http://base-apps.github.io/angular-base. Updates can be committed to the github pages branch https://github.com/base-apps/angular-base/tree/gh-pages.

@soumak77
Copy link
Contributor

@tolyo what will angular-base-website be needed for?

@AntJanus
Copy link
Contributor Author

We definitely don't need to port the CLI right away but I figure that if people got used to using it, I'd want to have a port of it, too. Whoever wants to support it can do so.

@tolyo as far as the angular-base-website, would that just be a port of https://github.com/zurb/foundation-apps-template?

@soumak77
Copy link
Contributor

In terms of version, should we just carry on where foundation apps left off? Meaning the first release of this framework would be a 1.3 release (or 1.2.1 if it ends up being a drop in replacement). I wouldn't mind starting the versioning from 1.0, but not sure if that will be confusing when people migrate.

@AntJanus
Copy link
Contributor Author

AntJanus commented Jun 13, 2016

Let's start from the original numbering. The rebrand should be like a patch: 1.2.1 or something with just READMEs, licenses, etc. updated. When we start adding the new aliases, we should bump it to 1.3 and follow semantic versioning from there.

That way, it's an easy drop-in replacement.

@soumak77
Copy link
Contributor

Works for me. I'll start working on converting the docs to GitHub pages in a day or two if someone else doesn't get to it first.

@tolyo
Copy link
Contributor

tolyo commented Jun 14, 2016

@AntJanus @soumak77 I was thinking of keeping documentation separate from the framework. I guess ghpages works just fine at this point.

@laurent-le-graverend
Copy link
Contributor

Congrats for moving this here,

About documentation, I believe most of beginners would still bet on Foundation for Apps, which is probably fine for them for the moment. You want to drive advanced developers attention first, before they would be the one to drive bugs reports and fixes.

The big miss on Foundation for Apps documentation is to not be enough API oriented.
They build a nice way to build and communicate across components, and I guess this is where a good documentation would matters.

new Modal() vs <zf-modal>...

@soumak77
Copy link
Contributor

@laurent-le-graverend I agree the API documentation is really poor. I've created issue #4 to discuss documentation changes.

@soumak77
Copy link
Contributor

@AntJanus We can likely push the documentation changes to the next release. Foundation for Apps docs should be appropriate for now since we won't be making any framework changes.

With that said, we may be able to push a release very shortly. Is there anything else we are waiting on other than verifying all tests are passing?

@AntJanus
Copy link
Contributor Author

@soumak77 nothing at all! We can push it out to NPM and Bower as soon as we merge in the docs.

@soumak77
Copy link
Contributor

@AntJanus when you say merge in the docs, what are you referring to? Seems as though we can just remove the docs from the repo entirely. Docs will have to be maintained in a different branch anyway, specifically https://github.com/base-apps/angular-base/tree/gh-pages.

@soumak77 soumak77 mentioned this issue Jun 14, 2016
10 tasks
@soumak77
Copy link
Contributor

Initial v1.2.1 release has been published. Due to a conflict in the bower registry, the package has been published under angular-base-apps.

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

No branches or pull requests

5 participants