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] Suggested Reading bug fix #10020
Conversation
Signed-off-by: Archit Sharma <archit8679@gmail.com>
🚀 Preview for commit bd69f5d at: https://65aa61cdde06af14124866fe--meshery-docs-preview.netlify.app |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently reads as: "Connections - Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are managed a state machine and used within one or more Environments."
This sentence requires a few grammar adjustments: "Connections - Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are managed a state machine and used within one or more Environments."
- did you mean to write "...managed as a state machine..."?
- the word environment in lowercase
Currently reads as: "Credentials - Meshery uses one or more Credentials when authenticating to a managed or unmanaged Connection."
This sentence requires a few grammar adjustments:
- the word connection in lowercase
Currently reads as: "Workspaces - Meshery Workspaces act as central collaboration points for teams"
This sentence requires a few grammar adjustments: "Workspaces - Meshery Workspaces act as central collaboration points for teams."
- missing full stop (.) at the end of the sentence
@sandramsc, that could be another issue because I am not writing descriptions, I am fetching those descriptions from the front matter of Markdown pages. |
🚀 Preview for commit 85835ce at: https://65ab7628f5229e6236ff5b05--meshery-docs-preview.netlify.app |
Yes, ideally, both of these are updated in accordance with your suggested change, @sandramsc
|
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
Oh, the reason that Environments and Credentials are uppercased is that we're treating them as keywords - Meshery core constructs. We need to either uppercase all the time or lowercase all the time. |
Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
@sandramsc's feedback incorporated. |
🚀 Preview for commit 05b96f6 at: https://65ab84107077ff6b0f4d98e7--meshery-docs-preview.netlify.app |
Notes for Reviewers
This PR fixes #9996
Signed commits