Skip to content
This repository has been archived by the owner on Aug 30, 2021. It is now read-only.

Documentation for 0.4 branch #443

Closed
darko-mijic opened this issue Mar 2, 2015 · 17 comments
Closed

Documentation for 0.4 branch #443

darko-mijic opened this issue Mar 2, 2015 · 17 comments

Comments

@darko-mijic
Copy link

Hello,

Does documentation for 0.4 branch exist?
I would like to see the draft version and I would like to contribute.

Regards,
Darko

@Shrizzy
Copy link

Shrizzy commented Mar 4, 2015

There's no specific documentation for 0.4 yet, but you can find the current documentation on the gh-pages branch. If you're keen, perhaps start with moving across the reusable parts of the current doco into the docs/0.4 folder.

I've noticed a lot of repos using Jekyll, and Kramdown for documentation lately. An example is express.js: https://github.com/strongloop/expressjs.com

@ilanbiala ilanbiala modified the milestone: 0.4.0 Mar 23, 2015
@codydaig
Copy link
Member

Has anybody started on the 0.4.0 docs yet? Can I set-up a Jekyll solution and get rolling on moving the old documentation that still applies over?

@Shrizzy
Copy link

Shrizzy commented Jul 15, 2015

I haven't seen much happening with the docs. If you're able to kick things off, submit a PR and we'll go from there.
Similar to Issue #294

@codydaig
Copy link
Member

See Pull Request #649

@lirantal
Copy link
Member

@codydaig yes, looks good.
please keep up the 0.4.0 documentation there and we also need to get more reviewers on that PR.

@codydaig
Copy link
Member

Should the 0.4.0 documentation follow the same format and structure as the current documentation? Does anybody have any changes they would like to see happen?

@lirantal
Copy link
Member

specifically I don't have any objections

This was referenced Jul 15, 2015
@ilanbiala
Copy link
Member

Condensed a few issues about 0.4 into this issue. For anyone who would like to contribute documentation to 0.4.0 @codydaig has helped us set up a Jekyll gh-pages site, so help us tie up loose ends and contribute any documentation you can!

@codydaig
Copy link
Member

I submitted a pull request #652 which demonstrates how documentation can be added. I also restructured the permalinks which I outlined and explained in the pull request.

My current question for discussion: I have not used the Yo Generator very much, so I would like some guidance. I'm assuming that the current version of the generator will still be accessible once 0.4.0 is released. With this assumption, I would structure the Yo Generator section the same as the documentation.
I'd appreciate some feedback and guidance on the structure and on the yo generator section.
Thanks!

@ilanbiala
Copy link
Member

@codydaig the generator will be put on hold until we can properly establish a simple way of using the mean repo instead of copying over and updating the files manually. Also, there is too much flux right now so we can't really keep updating so quickly.

@ilanbiala
Copy link
Member

I'm going to close this issue and we'll move future documentation discussion into more specific, separate issues if necessary.

@codydaig
Copy link
Member

@ilanbiala Just to clarify: we're going to keep the generator out of the 0.4.0 documentation and just say clone the repo or download the source code as the installation options for now?

@ilanbiala
Copy link
Member

Yes

@codydaig
Copy link
Member

@ilanbiala Thanks! I will get started on that tomorrow.

@lirantal
Copy link
Member

@codydaig I would leave the generator section there for people whom are targeting for that can find it and simply say there that the generator today works with the 0.3.0 stable version of MEAN.JS release, and not with the current master/0.4.0 branch.

@codydaig
Copy link
Member

@lirantal i should have clarified. I'm going to take the generator out of the 0.4.0 section as an installation option. But I will put a note on top of the generator section on the website saying it only works for 0.3.0.

@lirantal
Copy link
Member

cool

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

No branches or pull requests

5 participants