Skip to content
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

Console > Manage clusters > Setting pages only includes info about RBA #2877

Closed
akeller opened this issue Nov 7, 2023 · 5 comments · Fixed by #4059
Closed

Console > Manage clusters > Setting pages only includes info about RBA #2877

akeller opened this issue Nov 7, 2023 · 5 comments · Fixed by #4059
Assignees
Labels
component:console Issues related with Console project kind/bug Issues related with bugs in the documentation

Comments

@akeller
Copy link
Member

akeller commented Nov 7, 2023

There are at least two other settings on the settings page that should be included in the docs:

  • Toggling automatic cluster updates
  • Deleting the cluster

The screenshot should be updated as well to show all settings, or removed entirely.

image
@akeller akeller added kind/bug Issues related with bugs in the documentation component:console Issues related with Console project labels Nov 7, 2023
@akeller akeller mentioned this issue Nov 7, 2023
9 tasks
@akeller
Copy link
Member Author

akeller commented Jul 15, 2024

@mesellings this should be a relatively easy one for you to triage as you onboard and start to dig into the product experience. Given that this issue has been open for a while, please determine whether it's still relevant (maybe the product UI and docs have since been updated!). If it's no longer relevant, close the issue with a comment. If it is still relevant, how would you scope this to be improved in a 2-week increment (or less)?

@akeller akeller moved this from 🆕 Inbox to 🔖 Ready in Developer Experience Jul 15, 2024
@mesellings
Copy link
Contributor

@akeller Taking an initial look at this, the screenshot looks like it was updated, however there doesn't seem to be much actual documentation on the page itself, so I think it is worth some work just to improve the page for customers. Currently it feels like a placeholder page?

My recommendations are:

  • Perhaps remove the screenshot entirely - screenshots are useful, but this one might be overkill? The page text should mean we don't need a screenshot.
  • Document the settings on the page, at least at a basic level, either as concept or task (e.g. headings for each setting).
  • I would change some of the passive voice in the intro paragraph, and bullet them otherwise there is too much 'reading'/not easily scannable. Ideally a single sentence (shortdesc) to introduce the settings tab, followed by important bullets, and headed sections for each setting.

In terms of scope:

  • Estimated 1-3 days for investigation into the settings and then to create the content (assuming I have access to everything I need by then).

Is this something you would like me to do?

@akeller
Copy link
Member Author

akeller commented Jul 16, 2024

@mesellings, yes, please, and thank you for the well-scoped breakdown!

I like this as a small onboarding project that introduces you to our docs structure, SaaS, and the Console component. As you dig into this, you may want to do some other refactoring. If that comes up, create a new issue based on what you see and what you would change.

When you are ready to start working on this, move it to "In Progress" on the DevEx board. You can do that on the right-hand side of this issue or on the Project board itself. We can also talk more about this in our 1:1.

@mesellings mesellings moved this from 🔖 Ready to 🏗 In Progress in Developer Experience Jul 19, 2024
@mesellings
Copy link
Contributor

I will update this page in line with the software as follows:

  • Next & 8.5: RBA, Automatic cluster updates, Enforce user task restrictions, Delete cluster
  • 8.4 & 8.3: RBA, Delete cluster

@mesellings mesellings linked a pull request Jul 23, 2024 that will close this issue
9 tasks
@mesellings mesellings moved this from 🏗 In Progress to 👀 In Review in Developer Experience Jul 23, 2024
@mesellings
Copy link
Contributor

@akeller I've created a PR for this work - I think I have completed all the fields etc as per our guidelines.

@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Developer Experience Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:console Issues related with Console project kind/bug Issues related with bugs in the documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants