Sounds good, I‘ll open an issue
Gregor Gregor, could you perhaps file an issue in the Krazo issue tracker for this? This would be a good place to discuss how to structure it, where to place it and how we could publish it. Yes, that makes sense,
Ivar
I don't think that we need a separate repository just for the documentation. We could do this at a later point if required. For now, it is just important to get the licensing right I guess.
Of course versioning the documentation with Krazo would be the best option, but this would require to finish all the documentation BEFORE we push out a release. And I think currently we won't be able to do this. So for now I would recommend to just publish the docs from the "master" branch to site. We can improve this process later.
That would certainly be the easiest way since we wouldn't have to order a new repository. It actually also makes sense to version the guide with Krazo.
Ivar
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?
...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
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
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
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
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
Hi,
I think you could create a section called the "RI resource guide" or something.
similar to what is done in the "Installation Guides"
Em sex, 8 de fev de 2019 às 15:02, Gregor Tudan < gregor@xxxxxxxx> escreveu: Hi Team,
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.
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
--
_______________________________________________
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
--
_______________________________________________
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
--
_______________________________________________
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
--
_______________________________________________
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
--
|
