Skip to content
This repository has been archived by the owner on Dec 4, 2017. It is now read-only.

can we update the README.adoc if on OSIO? #46

Open
jstrachan opened this issue Aug 22, 2017 · 7 comments
Open

can we update the README.adoc if on OSIO? #46

jstrachan opened this issue Aug 22, 2017 · 7 comments

Comments

@jstrachan
Copy link
Contributor

I wonder how hard it'd be to update the ReadmeProcessor to generate nicer docs that are more suitable to OSIO?

e.g. there's no real docs in this generated quickstart thats of any relevance to using OSIO - which should focus on using Che to edit/run/debug then Jenkins CI / CD for CI + PRs and CD for versioned releases - and only after all that even mention stand alone (and am not sure it even should really - it'll just add confusion?)

@gastaldi
Copy link
Collaborator

Adding @rhoads-zach to the issue

@ghost
Copy link

ghost commented Aug 22, 2017

thanks @gastaldi.

@jstrachan I can add the content, but i need to see the boosters running in osio/che. Do you all still need to add the che stack info/config to the boosters? or can they run as-is?

@jstrachan
Copy link
Contributor Author

@rhoads-zach thanks!

the spring boot / vertx REST / configmap / health check boosters should run as is. (The CRUD / CircuitBreakers / WF Swarm ones don't run AFAIK) - we setup the Che stack correctly in the new project wizard (or import wizard)

@Ladicek
Copy link

Ladicek commented Aug 23, 2017

@jstrachan I know it's off topic here, but FYI, Swarm boosters will work after fabric8io/fabric8-team-components#122 is available on OSIO and Swarm 2017.9.0 is released and boosters updated (we had to workaround a JBoss Modules issue in Swarm). I only tested the basic REST booster, but will look at the other boosters this week.

@jstrachan
Copy link
Contributor Author

@Ladicek thanks! I hope to be able to test that soon

@gastaldi
Copy link
Collaborator

Just extracted the Readme template into a protected method which can be overriden in the OSIO addon: 5f3e5ad

@jstrachan
Copy link
Contributor Author

awesome thanks!

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

No branches or pull requests

3 participants