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] Suggested Reading bug fix #10020

Merged
merged 5 commits into from Jan 23, 2024
Merged

Conversation

iArchitSharma
Copy link
Contributor

@iArchitSharma iArchitSharma commented Jan 19, 2024

Notes for Reviewers

This PR fixes #9996

image

Signed commits

  • Yes, I signed my commits.

Signed-off-by: Archit Sharma <archit8679@gmail.com>
@github-actions github-actions bot added the area/docs Documentation update needed label Jan 19, 2024
@l5io
Copy link
Collaborator

l5io commented Jan 19, 2024

Copy link
Member

@sandramsc sandramsc left a 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

iArchitSharma and others added 2 commits January 20, 2024 12:53
Signed-off-by: Archit Sharma <archit8679@gmail.com>
@iArchitSharma
Copy link
Contributor Author

@sandramsc, that could be another issue because I am not writing descriptions, I am fetching those descriptions from the front matter of Markdown pages.

@l5io
Copy link
Collaborator

l5io commented Jan 20, 2024

@leecalcote
Copy link
Member

  • did you mean to write "...managed as a state machine..."?
  • the word environment in lowercase

Yes, ideally, both of these are updated in accordance with your suggested change, @sandramsc

  • did you mean to write "...managed as a state machine..."?
  • the word environment in lowercase

Signed-off-by: Lee Calcote <lee.calcote@layer5.io>
@leecalcote
Copy link
Member

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>
@leecalcote
Copy link
Member

@sandramsc's feedback incorporated.

@l5io
Copy link
Collaborator

l5io commented Jan 20, 2024

@leecalcote leecalcote merged commit 33a95e8 into meshery:master Jan 23, 2024
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Documentation update needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs Designs] - List items descriptions are identicle
4 participants