update documentation for next

[deepu105]

we need to update docs for next major. plz add on if i missed anything @jhipster/developers

• [x] 1. new angular folder structure & john papa style guideline
• [x] 2. removal of fast - PR submitted
• [x] 3. skip-client option - PR submitted
• [x] 4. grunt to gulp
• [x] 5. docker updates
• [x] 6. microservices - PR submitted, needs more contents
• [x] 7. naming convention updates for angular side and api endpoints, pluralization
• [x] 8. entity update option -PR submitted
• [x] 9. new advanced server & client sub gen
• [x] 10. update contribution.md to advice new structure changes if required
• [x] 11. we also need to update the presentation
• [x] 12. update the videos - Done
• [x] 13. We need to update the setting-CI page with gulp and remove the "Configuring Javascript Tests" which is now included by default.
• [x] 14. new --table-name flag in entity sub gen
• [x] 15. --with-entities to regen all entities
• [x] 16. --no-notification flag for gulp
• [x] 17 --angular-suffix option to add entity suffix
• [x] 18 switch to eslint instead of jshint
• [x] 19 --skip-user-management flag
• [x] 20 Internationalization - support for setting native language and additional languages
• [x] 21 have links to the script-base's jhipsterFunc from the creating-a-module page to have a quick view of the protoype and the function doc.
• [x] 22 changes in the generated war structure, no more single war for dev and prod
• [x] 23 Inject of js files with gulp serve and build
• [x] 24 microservice use cases, diagrams and advice
• [x] 25 update customizing_bootstrap.md with the new Gulp configuration
• [x] 26 update the technology stack to add the Netflix stack
• [x] 27 import-jdl sub generator
• [x] 28 docker compose sub generator
• [x] 29 gradle support in cloudfoundry sub gen
• [x] 30 new profile switches for swagger, liquibase
• [x] 31 jhipster registry (spring cloud config part) and jhipster console.

anything else?

[cbornet]

--with-entities to regen all entities

[jdubois]

Great job Deepu! I will also create a shared Google doc so we can prepare a clean release notes document. Btw the one from the 2.0 release got vandalized, so next time it won't be opened to comments. Le 4 févr. 2016 6:45 AM, "Christophe Bornet" notifications@github.com a écrit :

--with-entities to regen all entities

— Reply to this email directly or view it on GitHub https://github.com/jhipster/generator-jhipster/issues/2785#issuecomment-179654778 .

[deepu105]

awesome.

Thanks & Regards, Deepu

On Thu, Feb 4, 2016 at 3:43 PM, Julien Dubois notifications@github.com wrote:

Great job Deepu! I will also create a shared Google doc so we can prepare a clean release notes document. Btw the one from the 2.0 release got vandalized, so next time it won't be opened to comments. Le 4 févr. 2016 6:45 AM, "Christophe Bornet" notifications@github.com a écrit :

--with-entities to regen all entities

— Reply to this email directly or view it on GitHub < https://github.com/jhipster/generator-jhipster/issues/2785#issuecomment-179654778

.

— Reply to this email directly or view it on GitHub https://github.com/jhipster/generator-jhipster/issues/2785#issuecomment-179693917 .

[deepu105]

we also need to update the presentation and the videos

[cbornet]

We need to update the setting-CI page with gulp and remove the "Configuring Javascript Tests" which is now included by default.

[deepu105]

@jdubois if you want we can draft the notes in this ticket as well, coz I have locked it within the Jhipster team members and we will have markdown here so easy to copy paste :)

[jdubois]

@deepu105 I didn't know we could lock a conversation, that's cool!!!! In the jhipster.github.io repository I have created a specific branch for the 3.0 version, is it good for you? It's https://github.com/jhipster/jhipster.github.io/tree/v3_preparation

[deepu105]

Yes that should be good, so that we can all PR to that branch :) and probably do some dry run before the release

Btw here is the lock button below the participants :)

[gmarziou]

Here is a drawing I made to explain the JHipster 3 architecture to my team, I thought it could be converted to ASCII art for easier management in github but I think that some color would help or maybe some details should be removed.

[jdubois]

Excellent drawing @gmarziou !!

[deepu105]

@gmarziou check this out may be you can model this like here

[gmarziou]

nomnoml seems to target only UML class diagrams.

I went for ASCII art using asciiflow and Ditaa.

The benefits I see are:

• ASCII art diagram could be inserted in README.md of Registry and Gateway
• generated image for http://jhipster.github.io/, DItaa has a Jekyll plugin but I haven't used it yet

                                                  +--------------+
                                                  |    Browser   |
                                                  +-------+------+
                                                          |
                                                          |
                                                          V 8080
                               +-----------------------------------------------------+
                               | Gateway                                             |
                               | +-----------+    +--------------+      +----------+ |
                               | |           |    |  Zuul Proxy  |      |          | |     +-------+
                               | | Angular   |    |              |      |  Access  +-|---->|  {s}  |
                               | | App       |    +--------------+      |  Control | |     | Users |
                               | |           |    |    Ribbon    |      |          | |     | Roles |
                               | +-----------+    +---+------+---+      +----------+ |     +-------+
                               |                      |      |                       |
                               +-+---------------------------------------------------+
                                 |                    |      |       
                                 |                    |      |                              
                                 |                    |      |                        
                                 |        +-----------+      +----------------+            
+------------------------+       |        |                                   |
| JHipster Registry      |       |        V 8081                              V 8082
|                        |       | +-------------+                     +-------------+
|  +------------------+  |       | |             |     +-----+         |             |     +-----+
|  | Eureka Server    |  |       | |  Service 1  +---->| {s} |         |  Service 2  +---->| {s} |
|  +------------------+  |       | |             |     | DB1 |         |             |     | DB2 |
|  | Config Server    |  |       | +--+-----+----+     +-----+         +--+------+---+     +-----+
|  +--------+---------+  |  8761 |    |     |                             |      |
|           |            |<------+----+-----------------------------------+      |
+------------------------+                  |                                    |
            |                               +------------------------------------+
            V                               |
        +-------+                           V syslog
        |  {s}  |                   +---------------+
        |  Git  |                   |      ELK      |
        |  Repo |                   +---------------+
        +-------+

Here is the generated image, color could be added to blocks but we need to define its meaning.

[pascalgrimaud]

beautiful !

[gmarziou]

Thanks. I thought that maybe we could use color to indicate docker containers we provide: registry and ELK.

Also ELK could be detailed in its 3 components.

[jdubois]

Great, indeed! I've been doing the same one with Keynote, but here it must be easier to generate a custom diagram, and of course version it.

[gmarziou]

Here is another version using blue for Dockerized components and detailing ELK and green for users code, data or configuration.

Not sure which one is better.

[deepu105]

+1 for colors

[gmarziou]

v3_preparation branch is 57 commits behind master for jhipster.github.io

How should we proceed to submit PRs for JH3 in a way that would be as smooth as possible?

This makes me wonder whether we should keep the v2 site available somewhere or just replace it as soon as JH3 is out.

[deepu105]

maintaining versioned docs is a pain :( I don't know how we can maintain another version for 2.x may be we can copy the current site as it is and put in subfolder and link to it like jhipster.github.io/2x/

[deepu105]

or we can create a new repo called docs-2x in jhipster org and put current site as it is in the gh-pages branch and it will automatically be served in jhipster.github.io/docs-2x/ similar to how I hosted JDL-Studio

[jdubois]

Yes the versioned documentation is necessary, and I have no idea how to do it -> probably like @deepu105 says I need to do a specific repo for that, like for JDL Studio. Then I'm afraid we have many absolute URLs, so that can be really annoying.

[deepu105]

I guess Jekyll might handle it coz we append {{site.url}} on all urls, may be we can create a repo and try it out by copying from current site. Even if that fails we can assign the correct path to site.url var in global jekyll _config.yml and it should work

[deepu105]

so when someone visits jhipster.github.io/docs-2x/ they will be seeing a whole new site like JDL studio so there is no interference with the v3 site and v2 site and its easy for us to maintain both seperateley

[jdubois]

I just updated the v3 branch with a lot changes. It's not over yet, but at least there's no issue in merging to "master" when needed. You can see my changes here: https://github.com/jhipster/jhipster.github.io/commits/v3_preparation

I'll need help on the front-end stuff and on the different options, as I didn't follow everything closely enough.

[deepu105]

here are some updates https://github.com/jhipster/jhipster.github.io/pull/217

[deepu105]

@erikkemperman would you be willing to do item 22 in the todo since you did the PR?

[deepu105]

Ill do items 7, 10 , 11 and 25 as well by this week

[PierreBesson]

I will add documentation about the jhipster registry (spring cloud config part) and jhipster console.

[deepu105]

ok this is good progress so far :)

[deepu105]

@jdubois for the presentation (item 11) how do you want me to proceed. Should I use the same presentation and update just the content or do you want me to do a fresh presentation?

[jdubois]

@deepu105 it should be in the same presentation, as people want to have a good overview of everything

This doesn't have to be huge, some slides to add that we also support the microservices architecture, with a diagram, and saying that we use the Netflix stack

Can you also add something on our Docker Compose support? This is really great stuff, I don't know if people realize this.

[deepu105]

@cbornet about item 13, I dont see the Junit reporter configured anywhere. jenkins seems to be there is that enough? can you check and let me know . For now I have removed that section from docs

[deepu105]

@jdubois I have updated presentation here see if its enough or do you want to add more stuff?

[cbornet]

@deepu yes, karma-jenkins-reporter is a fork of karma-junit-reporter

[deepu105]

So that leaves only two more items to do :)

[jdubois]

Great job!!!

[deepu105]

@erikkemperman sorry for the locked ticket we were trying to avoid any spam when we draft release notes here. Anyway ill open it till the todo are done.

You can try to add those to using in development and using in production section of the docs

[pascalgrimaud]

I'm reviewing all part concerned by Docker and will do some PR

Tips : just tried this : docker run --rm --label=jekyll --volume=$(pwd):/srv/jekyll -it -p 4000:4000 jekyll/jekyll:pages to test/view the updated website ;-)

[jdubois]

@pascalgrimaud Docker is awesome :-)

[pascalgrimaud]

Happy you like Docker !!!

I'm updating the migration jdubois -> jhipster organization https://hub.docker.com/r/jhipster/jhipster/tags/ -> see the tag v2.27.2

[deepu105]

thanks a lot @erikkemperman

[deepu105]

just one more item left @PierreBesson I hope you are on to it :)

[deepu105]

@jdubois I guess we can use this thread to draft a release note as well what say?

[jdubois]

@deepu105 oh yes, I forgot I had to write the release notes... I'll start today.

[deepu105]

No worries just put in a skeleton and we all can update it with changelogs and finally you can jsut edit the post and copy the markdown from here :)

[deepu105]

btw I have locked this conversation again to collaborators to avoid any vandalism

[PierreBesson]

@deepu105 I'm on it since the end of last week. I will PR a new page on alerting with everything on it.

[jdubois]

All doc is done now, excepted maybe for the alerting stuff (but that's minor).

The v2 doc is available at https://github.com/jhipster/v2-documentation/tree/gh-pages and you can see it live at http://jhipster.github.io/v2-documentation/

So I'm closing this!

[deepu105]

:+1:

[deepu105]

@jdubois I have cleaned up some docs here https://github.com/jhipster/v2-documentation/pull/1

and for current repo here https://github.com/jhipster/jhipster.github.io/pull/227