atomicapp icon indicating copy to clipboard operation
atomicapp copied to clipboard

add more information guide linking. merge into atomicapp/docs?

Open cdrage opened this issue 10 years ago • 6 comments

If you click on the Atomic App Getting started Guide within the README.md it takes you to the page on projectatomic.io which is almost identical to the README.md of atomicapp.

Once there you have to click on Nulecule getting started guide to finally get to the page for more information located on projectatomic/nulecule which makes it even more confusing.

Wanted to open this issue for discussion. Do we simply update the README.md with the corresponding link directly to the getting started nulecule repo. Or shall we add a getting started guide to atomicapp/docs?

cdrage avatar Aug 31 '15 20:08 cdrage

From my point of view the flow should be more like Nulecule getting started and later on get practical with Atomic App getting started and we should link again aarons blog post.

All docs should be hosted on projectatomic.io and READMEs on repos should point that containing some abstracts.

We should also think about DevAssistant and ADB/BCL/BCJ and the BBC

@bexelbie @aweiteka @vpavlin

goern avatar Sep 01 '15 07:09 goern

I agree that the docs need a presence on projectatomic.io, however I don't think the sources should live there. I am concerned that if we put the sources in the website we 1) limit the number of commiters artificially and 2) make it even easier to do commits without docs.

Therefore I would propose that we leave the docs in the source repos and point to them from projectatomic.io. For now they are not so large as to demand a full "docs site" treatment. When they are we can revisit this (and probably create docs.projectatomic.io),

This still leaves #223 requiring a solution. The relationship between all the parts is getting very confusing for new people.

bexelbie avatar Sep 01 '15 08:09 bexelbie

maybe we can consolidate all the developer facing howto docs in docs/ (of atomicapp and nulecule) and shorten the readme, and push from docs/ to projectatomic.io/....

goern avatar Sep 01 '15 08:09 goern

@goern I was thinking along those lines as well. @jzb and crew will need to decide how rebuilds of projectatomic.io should be managed. I don't think they have CI on that yet .. but if we did sub-repositories or some other wizadry we could probably make it work without having to increase the number of website committers. Or we could add some committers to the site who stayed in the docs field only.

bexelbie avatar Sep 01 '15 08:09 bexelbie

Fixed after the docs refactor :)

Although incoming PR's from moi to update atomic-site @jberkus with an update on how to use atomicapp / nulecule.

cdrage avatar Mar 15 '16 17:03 cdrage

FYI: we are moving to a new model where docs will live at docs.projectatomic.io. This will allow you to push directly from your own docs repo to there without needing to add docs to atomic-site.

This should be ready in the next 2 weeks, and then we'll talk about getting the atomic.app and Nulecule docs in.

jberkus avatar Mar 15 '16 17:03 jberkus