docs: update images using latest UI screenshots #1992
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
Coverage report
Test suite run success1146 tests passing in 188 suites. Report generated by 🧪jest coverage report action from 975bef9 |
There was a problem hiding this comment.
Great work on this and lots of nice things you've caught 🙌🏼
I think I've either updated everything you've requested or asked for clarification if I'm not sure or if I disagree.
Just a few things to note in general (I think I saw a few of these):
- Try and avoid words like "click" (consider "select" or "use"; you can't click if you don't have a mouse 🐭 ) and "see" (not everyone has functioning eyesight 👀 )
- When updating (and changing images), make sure the alt text still applies or update it if it doesn't 😄
| @@ -27,7 +27,7 @@ curl -X POST -H "Content-Type: application/json" \ | |||
| https://app.unleash-hosted.com/demo/api/admin/features/Demo/toggle/on | |||
| ``` | |||
|
|
|||
| **Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the history (audit log) for this feature toggle. | |||
| **Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the Event log (history) for this feature toggle. | |||
There was a problem hiding this comment.
Suggested change
| **Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the Event log (history) for this feature toggle. | |
| **Great success!** We have now enabled the feature toggle. We can also verify that it was actually changed by the API user by navigating to the event log for this feature toggle. |
website/docs/advanced/audit-log.md
Outdated
| @@ -2,7 +2,7 @@ | |||
| id: audit_log | |||
| title: The audit log | |||
| --- | |||
|
|
|||
| @Thomas - should we call the page Event log instead? and replace all the text "audit log" with -> "event log"? | |||
There was a problem hiding this comment.
Yeah, I think that makes sense. We call it 'event log' in the UI, at least.
There was a problem hiding this comment.
I've done this in 72aefaf.
| @@ -18,3 +18,5 @@ You can find archived toggles in the toggle archive. The archive is accessible f | |||
| If you want to re-use a feature toggle that you previously archived, you can revive in from the feature toggle archive. Click the "revive icon" to revive the toggle. Revived toggles will be in the disabled state when you re-enable them. | |||
|
|
|||
| . | |||
|
|
|||
| @Thomas, maybe to explain also that now we can delete a feature toggle, and what are the consequences [i can prepare the screens, you can just put some screenshots and i will add the final ones] | |||
There was a problem hiding this comment.
Sounds good! I've addressed this and will let you take care of the rest
.
| @@ -260,6 +260,7 @@ Follow steps outlined in the [Run Unleash with Docker](#run-unleash-with-docker) | |||
|  | |||
|
|
|||
| Next, create an API key with these details | |||
| @Thomas - token type needs to be updated based on the new screen | |||
|
|
|||
| - **name:** proxy-key (this can be whatever you want) | |||
| - **token type:** client | |||
There was a problem hiding this comment.
Suggested change
| - **token type:** client | |
| - **what do you want to connect** server-side SDK (CLIENT) |
There was a problem hiding this comment.
@NicolaeUnleash is this what you meant?
| @@ -15,8 +15,8 @@ A toggle being (potentially) stale, does not affect how it performs in your appl | |||
|
|
|||
|
|
|||
| ## The technical debt dashboard | |||
|
|
|||
| In order to assist with removing unused feature toggles, Unleash provides a technical debt dashboard in the management-ui. You can find it by clicking on “Advanced” in the top-line menu then choose _Reporting_ in the dropdown menu. | |||
| @Thomas - is this technical debt dashboard still the correct naming? (wouldn't make more sens to updat it Health? in the entire page) | |||
There was a problem hiding this comment.
How about a compromise? Change the title to "Technical debt and project health"? Or maybe just "project health"? 🤔
| @@ -22,7 +22,7 @@ Before you can connect your application to Unleash you need a Unleash server. Yo | |||
| ### System Overview {#system-overview} | |||
|
|
|||
|  | |||
|
|
|||
| @Thomas - we need to review the text here, i updated the image (new: the orange text and one more option/setup) | |||
There was a problem hiding this comment.
I did some stuff in 7f6794a which I think should cover it. Let me know if you disagree 😄
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
Co-authored-by: Thomas Heartman <thomas@getunleash.ai>
thomasheartman
approved these changes
Sep 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updating images in the documentation using the latest UI screenshots
https://linear.app/unleash/issue/1-6/update-images-in-the-docs