search

camunda / camunda-bpm-platform

Flexible framework for workflow and decision automation with BPMN and DMN. Integration with Quarkus, Spring, Spring Boot, CDI.
https://camunda.com/
Apache License 2.0
4.09k stars 1.55k forks source link

Adjust get started guides in docs #2733

Closed ThorbenLindhauer closed 1 year ago

ThorbenLindhauer commented 2 years ago

This issue was imported from JIRA:

Field Value
JIRA Link CAM-14672
Reporter @toco-cam
Has restricted visibility comments false

Acceptance Criteria (Required on creation):

Hints (optional):

Links:

ThorbenLindhauer commented 1 year ago

We are currently planning to archiving the following guides:

garima-camunda commented 1 year ago

@toco-cam - Regarding

Content is moved to a place where it's still accessible, but not part of the regular release maintenance anymore (e.g. blog; moved into a separate "Archive" section)

garima-camunda commented 1 year ago

@toco-cam, @ThorbenLindhauer - I am discussing this with the team, and as of now we are leaning towards keeping these guides in the Get Started guide as is.

Reasons

  1. As far as we understand, these are useful for customers and community users.
  2. These are useful for the Support team for sure, as these guides are part of Support engineer onboarding. These guides are a good starting point for them (without overwhelming with the details) and try out samples.
  3. "Get Started" guides give an overview of different set-ups and important concepts needed for C7 learning, especially Java Process Application and Spring Framework.
  4. Moving these to Blog means customers would not be able to find them easily. Also, since Blog would not be updated, there are chances that someone refers to the Blog, and faces issues due to outdated content.

As I hear feedback from more Support engineers, I will post it here.

Thanks, Garima

toco-cam commented 1 year ago

Hey @garima-camunda, Thanks for the update. We dismissed the blog idea already.

"Archive" section We imagine it as a new headline in the docs. The content is still available but is not maintained/Updated anymore. Is maintaining and updating mandatory for your needs?

Greets Tobias

garima-camunda commented 1 year ago

Hi @toco-cam, thanks for the update. Let me get this reviewed with the team. I will get back to you.

garima-camunda commented 1 year ago

@toco-cam We are ok with moving the docs to "Archive" section. Our only request would be that those should not be hard to find, e.g.: keep them in 7.18 docs version but drop them from 7.19 version.

toco-cam commented 1 year ago

@garima-camunda: It is planned to have the archive in all upcoming versions, the only impact of having it in the archive is that it is not updated anymore.

tmetzke commented 1 year ago

@toco-cam and @ThorbenLindhauer, are we leaving RPA in there on top-level really? Isn't this C8's playground now so we can move away from this?

toco-cam commented 1 year ago

@tmetzke we ASAP want to mark RPA according to our strategy. For 7.19 you can move RPA to the end of the list.

tmetzke commented 1 year ago

This is what it looks like now: image

toco-cam commented 1 year ago

@tmetzke looks good! Does "fixed" mean, 7.18 is the last version we updated the content for?

mboskamp commented 1 year ago

@toco-cam, the guides currently all use 7.18.0. Adjusting those is part of the minor release. So now, we would not touch them anymore, they remain on 7.18.0.

tmetzke commented 1 year ago

Reopened: Let's see if we can add redirects to the archived guides for existing links out there 🙂

mboskamp commented 1 year ago

Looks good. Let's check the result on stage after the PR is merged.

tmetzke commented 1 year ago

Redirects look good on stage:

tmetzke commented 1 year ago

Adjustments are also "live" now: https://docs.camunda.org/get-started/javaee7/ ➡https://docs.camunda.org/get-started/archive/javaee7/

@toco-cam and @ThorbenLindhauer, do we want to create a Jakarta EE 10 guide in the near future? Or do we simply "abandon" that route regarding the getting started guides? Just interested here since we are also linking to the JEE 7 Guide from the examples repository.

toco-cam commented 1 year ago

@tmetzke any idea how different would it be from the existing one? For now I tend more on not doing so, as the motivation for Jakarta EE 10 is long term maintainability not new users.

tmetzke commented 1 year ago

@tmetzke any idea how different would it be from the existing one? For now I tend more on not doing so, as the motivation for Jakarta EE 10 is long term maintainability not new users.

It wouldn't be much different, I guess. Good point with maintainability vs. new users. Let's not add a new guide then 👍