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

ID admin tools, correct grammar #418

Closed
wants to merge 1 commit into from

Conversation

mjang
Copy link
Contributor

@mjang mjang commented Nov 22, 2023

I've modified the intro to:

  • Help readers ID the admin tools at a glance. Readers who already know how to set up Locking and Recovery mode won't need to go further. Readers who don't know will have links to both.
  • Correct grammar.
  • Capitalize "Qdrant"

IMO, the whole page could use a good rewrite, but one step at a time.

Copy link

netlify bot commented Nov 22, 2023

Deploy Preview for condescending-goldwasser-91acf0 ready!

Name Link
🔨 Latest commit 31377e1
🔍 Latest deploy log https://app.netlify.com/sites/condescending-goldwasser-91acf0/deploys/655d81e2c009fa000839055b
😎 Deploy Preview https://deploy-preview-418--condescending-goldwasser-91acf0.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Comment on lines +12 to +13
- [Locking](#locking)
- [Recovery mode](#recovery-mode)
Copy link
Member

Choose a reason for hiding this comment

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

Though I'm fine with listing these here, we also show them on the right in the table of contents.

@@ -7,7 +7,12 @@ aliases:

# Administration

Qdrant exposes administration tools which enable to modify at runtime the behavior of a qdrant instance without changing its configuration manually.
Qdrant exposes administration tools which allow you to modify the behavior of a Qdrant instance at runtime:
Copy link
Member

Choose a reason for hiding this comment

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

Recovery mode is not a runtime thing, so the original text was wrong.

What do you think about simplifying it to this?

Suggested change
Qdrant exposes administration tools which allow you to modify the behavior of a Qdrant instance at runtime:
Qdrant exposes administration tools:

Copy link
Contributor Author

@mjang mjang Nov 25, 2023

Choose a reason for hiding this comment

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

This is not the only page with Qdrant admin tools. I'd either change the title of this page, or maybe:

  • Move "locking" next to Authentication.
    • Even though "locking" is global, it's something that an admin would disable before others can create / add new data.
  • Move "recovery mode" under Troubleshooting.
    • While the page title is "Solving common errors," the ToC entry is "Troubleshooting"

I'm tempted to replace this PR with a "grammar only" change, and set up a new issue to organize all Qdrant admin tools: #423 . Does this make sense, @timvisee ?

@davidmyriel davidmyriel closed this Jul 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants