Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [krazo-dev] User Guide
We could simply create a "docs" folder in the Krazo repo and then add Asciidoc files there. In a first step we could then link to the rendered GitHub files from the mvc-spec.org site. Later we can create some CI job that renders the files to HTML and pushes them to Netlify (where the current mvc-spec.org site is hosted).

What do you think?

Am Sa., 9. Feb. 2019 um 17:08 Uhr schrieb Ivar Grimstad <ivar.grimstad@xxxxxxxxx>:
...ok...so maybe we should start a new repo with this guide to avoid any issues going forward?
And if we do, it would probably make more sense to create it in the Eclipse Krazo repo.

Ivar

On Sat, Feb 9, 2019 at 3:32 PM Christian Kaltepoth <christian@xxxxxxxxxxxx> wrote:
Hey Ivar,

good point! Unfortunately we forgot about adding any kind license information to the site repository and also didn't add the CLA. :-(

Christian



Am Sa., 9. Feb. 2019 um 11:07 Uhr schrieb Ivar Grimstad <ivar.grimstad@xxxxxxxxx>:
Actually, when I think about it, we should make sure to separate the MVC-specific parts from the Krazo-specific parts so it can be contributed to the jakartaee-tutorial later. This part will have to be under the EPL2+GPL(with classpath exception). The Krazo-specific parts may be Apache-2 (as Krazo).

Ivar

On Sat, Feb 9, 2019 at 10:59 AM Ivar Grimstad <ivar.grimstad@xxxxxxxxx> wrote:
Hi,

I agree that www.mvc-spec.org is a great place to start the guide. Later, a natural place would be under the Krazo project in a separate repository there. 
With that in mind, we must make sure that all contributors have signed the CLA and that we have licensed it correctly to make that transfer unproblematic. Not sure if we added the CLA check for the website...

Ivar

On Sat, Feb 9, 2019 at 10:28 AM Christian Kaltepoth <christian@xxxxxxxxxxxx> wrote:
Hey Gregor,

I think that www.mvc-spec.org would be a great place for a quick start guide. Adding new pages to the site is pretty easy as you just need to create a new Markdown or Asciidoc file in the corresponding directory.

In the long run we will also need some kind of full documentation. Something like the Weld documentation. IMO it should focus on setting up Krazo in different environments, configuring it (especially the non-spec features) and describe the extensions.

For now my vote goes for placing all this on www.mvc-spec.org. If we use some standard format like Markdown or Asciidoc, we can move it somewhere else later if we want to.

Christian



Am Fr., 8. Feb. 2019 um 19:02 Uhr schrieb Daniel Dias Dos Santos <daniel.dias.analistati@xxxxxxxxx>:
Hi,

I think you could create a section called the "RI resource guide" or something.

similar to what is done in the "Installation Guides"
--
Daniel Dias dos Santos
Java Developer
SouJava & JCP Member
Linkedin: www.linkedin.com/in/danieldiasjava


Em sex, 8 de fev de 2019 às 15:02, Gregor Tudan <gregor@xxxxxxxx> escreveu:
Hi Team,

I’d like to pick up the discussions from Github https://github.com/eclipse-ee4j/krazo/pull/45#issuecomment-461858176 about documenting Krazo specific features, that are outside the spec. This probably includes most extensions as well.

While the spec is great if you’re interested in all the nifty details, it might really help to drive the circulation of Krazo and MVC-Spec if users had some kind of QuickStart.
I guess this is something that makes most sense after we have a release that’s stable enough (RC? Final?), so we don’t run into too many breaking changes. 
Where would be a good place to put this ( MvcSpec.org / Eclipse.org ?)

What are your thoughts about this?

- Gregor 

_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev
_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev


--
Christian Kaltepoth

_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev
_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev


--
Christian Kaltepoth

_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev
_______________________________________________
krazo-dev mailing list
krazo-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/krazo-dev


--
Christian Kaltepoth
Blog: http://blog.kaltepoth.de/
Twitter: http://twitter.com/chkal
GitHub: https://github.com/chkal

Back to the top