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.

Sign up for GitHub

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

doc(fix): Update UI steps on how to reset or delete the corpus #404

Merged
merged 3 commits into from
Feb 5, 2025
Merged

doc(fix): Update UI steps on how to reset or delete the corpus #404

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5384e00
Update steps on resetting or deleting a corpus
pwoznic Feb 5, 2025
166fcc0
Update after review
pwoznic Feb 5, 2025
7c33c95
Update reset_or_delete_corpus.md
pwoznic Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions www/docs/console-ui/reset_or_delete_corpus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
---
id: reset-or-delete-corpus
title: Reset or Delete a Corpus
title: Disable, Clear, or Delete Corpus Data
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this is a little confusingly phrased. We should disambiguate between “clear corpus data” and “delete corpus”.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How about "Clear Corpus Data or Delete a Corpus" or simply just "Manage Corpus Data"?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Personally I think "Delete Corpus, Disable Corpus, and Clear Corpus Data" is clearest, even if it is wordy.

---

If you decide to stop using a corpus you have three options.
If you decide to stop using a corpus, you have three options on the corpus
**Settings** tab.

1. **Disable**: Disables query or indexing requests. A disabled corpus can be
reenabled at any time from this same page.
2. **Reset**: Clear all the data within the corpus, but leave the corpus
2. **Clear corpus data**: Clear all the data within the corpus, but leave the corpus
definition intact.
3. **Delete**: Purge all the data within the corpus and delete the corpus.
All your connected services to the corpus will also cease to function.

:::caution
The **Reset** and **Delete** operations are irreversable.
The **Clear corpus data** and **Delete** operations are irreversable.
:::

The Dangerous actions section of the Manage corpus page lets you disable,
reset, or delete a corpus.

1. Select the drop-down menu of your corpus name and click Manage.
2. Go to the bottom of the Manage page to the Danagerous actions section.
3. Select **Disable corpus**, **Clear corpus data**, or **Delete corpus**.
1. Navigate to your corpus and select the **Settings** tab.
2. Go to the **Danagerous actions** section at the bottom of the page.
3. Select one of the following options:
* Click **Disable corpus**.
* Click **Clear corpus data**.
* Click **Delete corpus**.

![Reset or delete corpus](/img/reset_or_delete_corpus.png)
Binary file modified www/static/img/reset_or_delete_corpus.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading