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

Updates Tenant Token Documentation #2928

Closed
wants to merge 5 commits into from

Conversation

postmeback
Copy link
Contributor

@postmeback postmeback commented Aug 5, 2024

Pull Request

Related issue

Fixes #2893 & #2774

What does this PR do?

  • Fixes two minor issues in the documentation.

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@postmeback
Copy link
Contributor Author

Requesting the reviewers to have a look.

Copy link
Member

@guimachiavelli guimachiavelli left a comment

Choose a reason for hiding this comment

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

Hello @postmeback! Thanks for your interest in contributing to the Meilisearch docs.

I'm afraid I will have to refuse your contribution and close the PR because it doesn't meet our quality standards:

  1. Your proposed fix for the JWT link is not in a helpful spot. You placed it right after a sentence talking about encryption algorithms, which implies users will learn more about a the subject. jwt.io's homepage has almost no information on that subject. A better place would have been at the beginning of the article
  2. Additionally, you added the link with a generic "click here". Link text should be descriptive and better integrated in the regular text flow
  3. Your second fix hijacks an example explanation with information extraneous to that example. That is confusing and unhelpful for users
  4. Your second fix also makes unnecessary use of <br>s. Never use <br> to create new lines as this leads to unclear information hierarchy and might cause presentation issues depending on screen size
  5. This is not a hard rule, but we generally prefer to have a single PR per issue unless the issues are very closely related. This makes the PR easier to review and avoids PR scope creep. Webtokens and the limit search parameter are completely unrelated.

Thanks again for the interest!

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.

Reference jwt.io in tenant tokens documentation
2 participants