Hi Serge, Ok for the graduation requirements, I will add the content. For the source repository, I think it would be great to put it on Git. I will easily push a PR ;) Regards,
Envoyé depuis mon smartphone Samsung Galaxy. -------- Message d'origine --------De : Serge Huber <[email protected]> Date : 24/08/2018 11:50 (GMT+04:00) À : [email protected] Objet : Re: [PROPOSAL] - Website and documentation Hello François, Thanks for all the changes, I really like them. For the graduation requirements, we have a maturity report here: http://unomi.apache.org/maturity-model-report.html You will see that most of the content needed is for example available on the Apache Beam website in the URLs I sent in my previous message in this thread (for example how to handle security issues). Also I had a question about where we would put the new website ? Would we directly host it in the Subversion or would we put it somewhere in the Git repository ? Regards, Serge... ps: the 1.3.0 release was just approved, I need to put it on the website today :) On Fri, Aug 24, 2018 at 4:15 AM Francois Papon <[email protected]> wrote: > > Hi, > > I made some change on the website after have a look to the Apache Beam > website : > > - update the home page header > > - remove news page, may be not necessary because we already have a > section news on the home page > > - add a "get started" page for the newcomers, I will write some section > for how to a new user can install and start using Apache Unomi. We could > add some examples for how to use after install. > > - add a "contribute" page (need to be complete) > > - update the "community" page > > Their is a lot of content in the Apache Beam website and have to see > what we have to keep to be compliant for the graduation : where can I > find the informations about the graduation requirements ? > > regards, > > François Papon > [email protected] > > Le 23/08/2018 à 18:48, francois.papon a écrit : > > Ok, I will take a look on the Beam website and see how to use it as > > inspiration :) > > regards, > > François > > > > > > Envoyé depuis mon smartphone Samsung Galaxy. > > -------- Message d'origine --------De : Serge Huber <[email protected]> Date > > : 23/08/2018 18:26 (GMT+04:00) À : [email protected] Objet : > > Re: [PROPOSAL] - Website and documentation > > Looks much better thanks! And I tested in a mobile format it works > > except for the bottom footer that looks a bit garbled (see attached > > image). Btw I'm using Safari's Responsive Design mode to test this (in > > the develop menu). > > > > For the main documentation is the idea (still) to copy this over at a > > later stage? > > > > Thanks again for all the work. > > > > We will also need to add more contribution pages to be compliant with > > the requirements for graduation, for example, we should copy the > > contents of the beam site for these pages: > > https://beam.apache.org/contribute/ and > > https://beam.apache.org/community/contact-us/ > > > > Btw, in general, I really like the Apache Beam site. Maybe we could > > use it as inspiration? > > > > Serge Huber > > CTO & Co-Founder > > > > T +41 22 361 3424 > > 9 route des Jeunes | 1227 Acacias | Switzerland > > jahia.com > > SKYPE | LINKEDIN | TWITTER | VCARD > > > > > >> JOIN OUR COMMUNITY to evaluate, get trained and to discover why Jahia is a > >> leading User Experience Platform (UXP) for Digital Transformation. > > On Thu, Aug 23, 2018 at 2:55 PM Francois Papon > > <[email protected]> wrote: > >> Hi, > >> > >> I pushed an update for the mobile responsive menu and I reduced the > >> font-size and space. > >> > >> regards, > >> > >> François Papon > >> [email protected] > >> > >> Le 23/08/2018 à 08:50, Francois Papon a écrit : > >>> Hi Serge, > >>> > >>> Thanks for your feedback ! > >>> > >>> For the maven pom, we use it in Karaf to deploy via scm, I can remove it > >>> if no needs. > >>> > >>> For the getting start part, I put the 5 minutes quick start on the main > >>> page, if you are talking about part in the main documentation, it's > >>> normal but I can add it. > >>> > >>> I will down the font size and reduce some space as you say. > >>> > >>> The CSS is Bootstrap 4, I will check for the menu on mobile (it work > >>> well on Karaf website and I just forked the site). > >>> > >>> I tried to update quickly ;) > >>> > >>> It's a good idea the have animation or video, and we also have some > >>> highlight on the caroussel at the top of the main page. The "use cases" > >>> page can also have some additional content to explain how users can > >>> integrate Unomi in their legacy system easily. > >>> > >>> regards, > >>> > >>> François Papon > >>> [email protected] > >>> > >>> Le 22/08/2018 à 23:19, Serge Huber a écrit : > >>>> Hi François, > >>>> > >>>> Thanks for your work. I tried to compile the project but I got the > >>>> following error : > >>>> > >>>> [INFO] Scanning for projects... > >>>> [ERROR] [ERROR] Some problems were encountered while processing the POMs: > >>>> [FATAL] 'version' is missing. @ line 23, column 106 > >>>> @ > >>>> [ERROR] The build could not read 1 project -> [Help 1] > >>>> [ERROR] > >>>> [ERROR] The project org.apache.unomi:site:[unknown-version] > >>>> (/Users/loom/temp/incubator-unomi-website/pom.xml) has 1 error > >>>> [ERROR] 'version' is missing. @ line 23, column 106 > >>>> [ERROR] > >>>> [ERROR] To see the full stack trace of the errors, re-run Maven with > >>>> the -e switch. > >>>> [ERROR] Re-run Maven using the -X switch to enable full debug logging. > >>>> [ERROR] > >>>> [ERROR] For more information about the errors and possible solutions, > >>>> please read the following articles: > >>>> [ERROR] [Help 1] > >>>> http://cwiki.apache.org/confluence/display/MAVEN/ProjectBuildingException > >>>> > >>>> After adding a version however it worked fine ! > >>>> > >>>> I like the overall result although it seems like it is using a lot of > >>>> space and some fonts seem really large. Also it seems some stuff is > >>>> missing like the getting started (I couldn't find it). > >>>> > >>>> I like the new documentation part, some nice ideas there. > >>>> > >>>> My biggest concern is on-boarding newcomers with the site, and I think > >>>> they shouldn't have to read through a lot of content to understand > >>>> what the project does. Ideally maybe we should look into producing > >>>> some kind of video or a quick animation. > >>>> > >>>> Finally I tried the site on a mobile device and it seems the > >>>> navigation completely disappears. > >>>> > >>>> Anyway thanks for the effort I like it ! > >>>> > >>>> cheers, > >>>> Serge... > >>>> On Wed, Aug 22, 2018 at 12:12 PM Francois Papon > >>>> <[email protected]> wrote: > >>>>> Hi, > >>>>> > >>>>> I worked on a preview version of the website and published it on my > >>>>> github repo : > >>>>> > >>>>> https://github.com/fpapon/incubator-unomi-website > >>>>> > >>>>> I also started to work on a easy way to publish the documentation from > >>>>> markdown to HTML and PDF. > >>>>> > >>>>> May be it could be nice to archive the documentation related to the > >>>>> maven project with git tag because today it's on differents folder in > >>>>> the src/ of the project. > >>>>> > >>>>> Thoughts ? > >>>>> > >>>>> regards, > >>>>> > >>>>> François Papon > >>>>> [email protected] > >>>>> > >>>>> Le 03/08/2018 à 00:14, Serge Huber a écrit : > >>>>>> Thanks François, looking forward to the PR ! > >>>>>> > >>>>>> If you want to work on the website you're more than welcome to start > >>>>>> working on it, as I said the more people get involved the better for > >>>>>> the project ! > >>>>>> > >>>>>> Regards, > >>>>>> Serge.. > >>>>>> On Wed, Aug 1, 2018 at 8:48 PM Francois Papon > >>>>>> <[email protected]> wrote: > >>>>>>> Ok for Swagger, I will post a PR. > >>>>>>> > >>>>>>> About the website, let me know when you want me to start working on it > >>>>>>> (I already have a repo on my github account). > >>>>>>> > >>>>>>> regards, > >>>>>>> > >>>>>>> François Papon > >>>>>>> [email protected] > >>>>>>> > >>>>>>> Le 01/08/2018 à 18:25, Serge Huber a écrit : > >>>>>>>> Feel free to help out on Swagger, I have little to no experience > >>>>>>>> with it. > >>>>>>>> > >>>>>>>> As for the GraphQL side, it's very experimental code that is > >>>>>>>> constantly changing right now, so be warned that things might change > >>>>>>>> quite significantly at any point but feel free to look at it and give > >>>>>>>> feedback or even contribute! > >>>>>>>> > >>>>>>>> cheers, > >>>>>>>> Serge... > >>>>>>>> > >>>>>>>> Serge Huber > >>>>>>>> CTO & Co-Founder > >>>>>>>> > >>>>>>>> T +41 22 361 3424 > >>>>>>>> 9 route des Jeunes | 1227 Acacias | Switzerland > >>>>>>>> jahia.com > >>>>>>>> SKYPE | LINKEDIN | TWITTER | VCARD > >>>>>>>> > >>>>>>>> > >>>>>>>>> JOIN OUR COMMUNITY to evaluate, get trained and to discover why > >>>>>>>>> Jahia is a leading User Experience Platform (UXP) for Digital > >>>>>>>>> Transformation. > >>>>>>>> On Wed, Aug 1, 2018 at 9:00 AM Francois Papon > >>>>>>>> <[email protected]> wrote: > >>>>>>>>> Cool, > >>>>>>>>> > >>>>>>>>> If needed, I can help on the Swagger and the GraphQL integration ;) > >>>>>>>>> > >>>>>>>>> regards, > >>>>>>>>> > >>>>>>>>> François Papon > >>>>>>>>> [email protected] > >>>>>>>>> Yupiik - https://www.yupiik.com > >>>>>>>>> > >>>>>>>>> Le 31/07/2018 à 23:01, Serge Huber a écrit : > >>>>>>>>>> Hello François, > >>>>>>>>>> > >>>>>>>>>> Thanks for clarifying that I wasn't aware that you could use > >>>>>>>>>> Swagger > >>>>>>>>>> that way. That makes sense. > >>>>>>>>>> > >>>>>>>>>> For GraphQL yes the final version of the CXS specification I'm also > >>>>>>>>>> co-developing has switched from REST to GraphQL, and I'm currently > >>>>>>>>>> implementing that in a branch to validate the design of the GraphQL > >>>>>>>>>> schema. It's a challenge because we are doing some advanced stuff > >>>>>>>>>> with > >>>>>>>>>> GraphQL but the API is already a lot more powerful than the REST > >>>>>>>>>> API. > >>>>>>>>>> > >>>>>>>>>> cheers, > >>>>>>>>>> Serge... > >>>>>>>>>> On Tue, Jul 31, 2018 at 6:25 PM Francois Papon > >>>>>>>>>> <[email protected]> wrote: > >>>>>>>>>>> Hi Serge, > >>>>>>>>>>> > >>>>>>>>>>> Thanks for your feedback :) > >>>>>>>>>>> > >>>>>>>>>>> I see the Miredot documentation and for me it's good. > >>>>>>>>>>> > >>>>>>>>>>> I propose to add Swagger (not to replace Miredot) to have a GUI to > >>>>>>>>>>> simulate request and response for developers. > >>>>>>>>>>> > >>>>>>>>>>> I already used the cxf-swagger-feature in a Karaf project and the > >>>>>>>>>>> only > >>>>>>>>>>> bug I found it's the refresh of the json when updating the bundle > >>>>>>>>>>> in a > >>>>>>>>>>> started instance. > >>>>>>>>>>> > >>>>>>>>>>> I have in mind to propose a page on the website dedicated to the > >>>>>>>>>>> API > >>>>>>>>>>> like this : > >>>>>>>>>>> > >>>>>>>>>>> https://projects.tmforum.org/wiki/display/API/Open+API+Table > >>>>>>>>>>> > >>>>>>>>>>> I saw a JIRA about GraphQL integration, it's great :) > >>>>>>>>>>> > >>>>>>>>>>> regards, > >>>>>>>>>>> > >>>>>>>>>>> François Papon > >>>>>>>>>>> [email protected] > >>>>>>>>>>> > >>>>>>>>>>> Le 31/07/2018 à 19:48, Serge Huber a écrit : > >>>>>>>>>>>> Hello François, > >>>>>>>>>>>> > >>>>>>>>>>>> Thank you for your proposal, I really like the new design ! > >>>>>>>>>>>> > >>>>>>>>>>>> For me, the user documentation could be reformated to make it > >>>>>>>>>>>> easier > >>>>>>>>>>>> to browse and of course, it always needs improving and detailing. > >>>>>>>>>>>> > >>>>>>>>>>>> Concerning the REST API documentation, currently, we use another > >>>>>>>>>>>> tool > >>>>>>>>>>>> to generate it from the source code, and it is capable of > >>>>>>>>>>>> documenting > >>>>>>>>>>>> the JSON structure at the same time. The whole source code was > >>>>>>>>>>>> documented to work with this plugin (http://www.miredot.com/) for > >>>>>>>>>>>> which we got a free license since it is an Apache project. Are > >>>>>>>>>>>> you > >>>>>>>>>>>> suggesting we replace this with Swagger (we evaluated it at the > >>>>>>>>>>>> time > >>>>>>>>>>>> but it was missing some features for generating from the code) ? > >>>>>>>>>>>> > >>>>>>>>>>>> Regards, > >>>>>>>>>>>> Serge... > >>>>>>>>>>>> On Tue, Jul 31, 2018 at 2:42 PM Francois Papon > >>>>>>>>>>>> <[email protected]> wrote: > >>>>>>>>>>>>> Hi, > >>>>>>>>>>>>> > >>>>>>>>>>>>> I'm new with the Apache Unomi project and I would like to make > >>>>>>>>>>>>> some > >>>>>>>>>>>>> proposals around the website and the documentation :) > >>>>>>>>>>>>> > >>>>>>>>>>>>> *1 - Website :* > >>>>>>>>>>>>> > >>>>>>>>>>>>> Actually, the website is auto generate and link to the project > >>>>>>>>>>>>> release > >>>>>>>>>>>>> livecycle, however we could made some changes any time, like > >>>>>>>>>>>>> posting > >>>>>>>>>>>>> news, uses cases... > >>>>>>>>>>>>> > >>>>>>>>>>>>> That's why I think the website can have he's dedicated > >>>>>>>>>>>>> repository and > >>>>>>>>>>>>> could be only build on html static pages. > >>>>>>>>>>>>> > >>>>>>>>>>>>> I started a WIP with the home page and you can have a preview > >>>>>>>>>>>>> here : > >>>>>>>>>>>>> https://openobject.fr/unomi > >>>>>>>>>>>>> > >>>>>>>>>>>>> *2 - User guide :* > >>>>>>>>>>>>> > >>>>>>>>>>>>> The user guide is good and could be link to the release, may be > >>>>>>>>>>>>> to major > >>>>>>>>>>>>> release ? > >>>>>>>>>>>>> > >>>>>>>>>>>>> We have the documentation in md format for Github and html for > >>>>>>>>>>>>> the > >>>>>>>>>>>>> website, we also could have a pdf from the html. > >>>>>>>>>>>>> > >>>>>>>>>>>>> *3 - API Rest documentation :* > >>>>>>>>>>>>> > >>>>>>>>>>>>> May be we could provided an instance of Swagger from the > >>>>>>>>>>>>> website for > >>>>>>>>>>>>> developers, it's convenient for have some request/response > >>>>>>>>>>>>> (their is an > >>>>>>>>>>>>> existing cxf-swagger feature for generating the json). > >>>>>>>>>>>>> > >>>>>>>>>>>>> > >>>>>>>>>>>>> If you are interesting, I can help on this items :) > >>>>>>>>>>>>> > >>>>>>>>>>>>> regards, > >>>>>>>>>>>>> > >>>>>>>>>>>>> -- > >>>>>>>>>>>>> François Papon > >>>>>>>>>>>>> [email protected] > >>>>>>>>>>>>> > >
