-
Notifications
You must be signed in to change notification settings - Fork 190
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Overhaul identity docs #2814
Overhaul identity docs #2814
Conversation
title: "Installation and first steps" | ||
sidebar_label: "Installation and first steps" | ||
description: "Learn more about installing Identity, accessing the UI, default users, the home screen, and more." | ||
title: "First steps" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is only an introduction to initial configuration and UIs after logging in with demo demo. All installation instructions were moved.
@@ -21,6 +23,9 @@ Navigate to [localhost:8080](http://localhost:8080) to see the UI exposed by Ide | |||
|
|||
The configuration in this guide creates an example user during installation; use this account to log in: | |||
|
|||
<!-- Is this true for any setup? --> | |||
<!-- For setting up production systems, we should nudge users to remove this configuration prior to launching. --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need to add removing the demo user from https://docs.camunda.io/docs/self-managed/identity/user-guide/configuration/making-identity-production-ready/?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The demo user is included in the helm charts (it seems that this is the default case). Therefore it would make sense to also have it documented in the helm installation part of the docs. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interesting - we should surely mention that the demo/demo user is created by default in the Helm chart.
Do we need this page, then? Could we consolidate it with the "What is Identity" page and walk through what screens are available in the Identity UI?
@christinaausley I was working with @dlavrenuek on #2630 and decided to just open a PR using an approach I've seen you do - adding comments to the PR directly for collaboration. I'm not sure how much you'll be able to add with the questions I've asked, but I wanted to include you early for awareness. |
@@ -5,11 +5,7 @@ sidebar_label: "Incorporate applications" | |||
description: "Use Identity to create an application and assign a permission to an application." | |||
--- | |||
|
|||
In this guide we will show you how to use Identity to create an application and assign a permission to an application. | |||
|
|||
:::tip Want to learn more about applications? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed this and used an in-line link in the sentence above since we have a caution admonition right below it.
@dlavrenuek I left a mix of comments, changes, and commented questions in this PR. Can you have a look? |
- Public | ||
|
||
Public and confidential applications are applications where a user can log in, like a custom Tasklist. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good opportunity to link to both Tasklist and service worker documentation in the case users aren't familiar.
@felix-mueller are you able to answer some of the questions in this PR or provide concrete examples? |
@dlavrenuek @felix-mueller how do you want to handle this moving forward? I can move questions into an epic, chunk up this PR into smaller increments, or close it. Some of this is covered by https://camunda.slack.com/archives/C064WFE0MV1/p1702317421204349. How can I support collaborative improvements here? |
@akeller apparently I did not notice that I was mentioned in this thread where my input was required, which is very unfortunate. Since I will be away for a longer time starting next week, I would like to let @felix-mueller handle the the prioritization on our side. |
Closing this as stale. Will continue smaller projects to improve Identity docs. |
Description
Adjustments covering internal feedback and open issues in the Identity docs, including:
Missing pieces include a "why" or a concrete example. Being more opinionated or concrete helps users learn and work with Identity quickly. This includes:
Out of scope:
When should this change go live?
hold
label or convert to draft PR)?PR Checklist
/versioned_docs
directory, or they are not for an already released version./docs
directory (aka/next/
), or they are not for future versions.