devonfw-forge / devonfw-microservices

Apache License 2.0
2 stars 7 forks source link

Integration into the documentation #35

Closed SchettlerKoehler closed 3 years ago

SchettlerKoehler commented 3 years ago

Move every documentation done in the devonfw-microservices repo to the architecture browser or the docs section of the website.

hohwille commented 3 years ago

I have already setup the initial structure of the repo @SchettlerKoehler created: https://github.com/devonfw/devon4quarkus

So we have CI for master branch and for PRs as well as documentation synchronization to wiki for devonfw guide. Now the documentation folder in this new repo can be filled and in case any lib code needs to be written, it also has a new home where to place it.

Sample applications however, should have their own repo in https://github.com/devonfw-sample/

hohwille commented 3 years ago

IMHO https://github.com/devonfw/devon4quarkus should only contain quarkus/Java specific stuff. Generic documentation such as "How do I do a service mesh (with kubernetes and Istio)" or "how do I setup and integrate IAM (with keycloak)" is cross-cutting and therefore relevant for all stacks (Java, C#, Node.js, etc.). If suitable such content can start in the architecture browser.

hohwille commented 3 years ago

From our website we should present that we hava different stacks:

For the outside-in view via the website we should avoid starting with technical names such as devon4j or devon4net.

SchettlerKoehler commented 3 years ago

There are tasks for that that will be taken up by the "New UI experience" team: https://github.com/devonfw/devonfw.github.io/issues/159 https://github.com/devonfw/devonfw.github.io/issues/151

GuentherJulian commented 3 years ago

I created some new issues in devon4quarkus and in the architecture repository to create the documentations on devon4quarkus and move the documentations created in this repository.

hohwille commented 3 years ago

IMHO we can now close this issue here.