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

[docs] Trash #43049

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

[docs] Trash #43049

wants to merge 9 commits into from

Conversation

alexyarosh
Copy link
Contributor

Rename archive to Trash, pull it out of History, and add explanations of how trashing affects related items.

Not sure if it should have a backport label considering RC1 was cut

Things to think about:

Name and content:

  • This goes into “Organization” topic so I thought “”the means/goal of organization action” (delete and restore) would be a better name than ”the place where it goes” (Trash).
    But then this also made me think that people might come to that article to learn about deleting items that don’t go into trash, so I added a bunch of links to other delete-like actions.

Article organization:

  • There are a lot of repeated instructions which I don’t like. On the other hand, I wanted to have detailed section titles for better searcheability. Alternative would be to have delete/restore instructions as one section, and then separate the effects of delete actions into sections.

Downstream effects:

  • I think I noted most of the possible consequences/interactions of deleting something, but let me know if I missed something!

@alexyarosh alexyarosh self-assigned this May 23, 2024
@jeff-bruemmer jeff-bruemmer added the backport Automatically create PR on current release branch on merge label May 23, 2024
Copy link
Member

@jeff-bruemmer jeff-bruemmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • We should prioritize human eyeballs first, then machine eyeballs. To that end, we could significantly consolidate these docs. I'm not categorically against duplication, but here the repetition makes it easy to see the trees, but not the forest.
  • The forest: we should talk about how to delete and restore items in general, then list the effects of a trash move for each type of item. I doubt many people will ever search for how to delete something. What people might want to read is info about what happens to related items when they delete something. E.g., "what happens to items and sub-collections when you move a collection to the trash", or dashboard cards/subscriptions, or models with downstream questions, etc.
  • In general, use existing docs and expand them, rather than repeat elsewhere. E.g., the search section should be a one-liner that links to the search section (this linking will eliminate at least one screenshot).
  • Speaking of screenshots: I prefer a little more visual context in the images. Right now the menus are isolated/disconnected from the larger UI so they're difficult to situate in context. And since the menus are straightforward, it's more important to show people where to find the menus, not how to use them.
  • I know our table support isn't stellar, but there are some opportunities for them here to enumerate item cases (I gave one hasty example in-line re: model trashing).

I know I'm asking for a lot of changes, but this is an excellent first draft, @alexyarosh. Very thorough. Made it easy to edit and identify the important stuff we should highlight.

docs/README.md Outdated Show resolved Hide resolved

You;'ll be able to see the contents of deleted dashboards, questions, and models in Trash, but you won't be able to modify them.

## Search in Trash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section should just link to search section:
You can search for items in the trash https://github.com/metabase/metabase/blob/master/docs/exploration-and-organization/exploration.md#advanced-search

docs/exploration-and-organization/delete-and-restore.md Outdated Show resolved Hide resolved
docs/exploration-and-organization/delete-and-restore.md Outdated Show resolved Hide resolved

You'll still be able to browse the collection in Trash. Individual items from a deleted collection and can be restored or moved from Trash to a different collection.

To restore a collection:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why can you restore some collections, but not others?

docs/permissions/collections.md Show resolved Hide resolved
@alexyarosh
Copy link
Contributor Author

Thanks for awesome feedback @jeff-bruemmer ! Check out the new draft

Copy link
Member

@jeff-bruemmer jeff-bruemmer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few comments to address before merging.

And remember to remove unused images from the PR.

Nice work.

alexyarosh and others added 2 commits May 28, 2024 16:43
Co-authored-by: Jeff Bruemmer <jeff.bruemmer@gmail.com>
@alexyarosh
Copy link
Contributor Author

Trash is not making it to v50 so putting this on hold for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Automatically create PR on current release branch on merge Type:Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants