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

fix(typo): test #11

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(typo): test #11

wants to merge 1 commit into from

Conversation

bhalothia
Copy link
Member

@bhalothia bhalothia commented May 22, 2024

Summary by CodeRabbit

  • Documentation
    • Minor edit in the README: Removed a period from the description of "The Complete DevOps Glossary."

Copy link

coderabbitai bot commented May 22, 2024

Walkthrough

The change involves a minor edit to the README.md file, specifically removing a period at the end of a sentence in the description of "The Complete DevOps Glossary". This alteration does not affect any exported or public entities within the codebase.

Changes

Files Change Summary
README.md Removed a period at the end of a sentence in the description of "The Complete DevOps Glossary".

In the land of code, where changes flow,
A period left, it had to go.
With gentle touch, the README's clear,
A tiny tweak, no need to fear.
The glossary shines, with grace anew,
A rabbit’s work, for all to view. 🐇


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Outside diff range and nitpick comments (3)
README.md (3)

Line range hint 17-17: Use "An" instead of "A" before words that start with a vowel sound.

-  - [AWS](https://aws.amazon.com) - A cloud computing platform offering ready to use web services which are loosely coupled.
+  - [AWS](https://aws.amazon.com) - An cloud computing platform offering ready to use web services which are loosely coupled.

Line range hint 21-21: Add a hyphen to the compound adjective.

-  - [Artifactory](https://github.com/Netflix/asgard/wiki) - JFrog’s open source binary repository management product with support for Apache Maven artifacts.
+  - [Artifactory](https://github.com/Netflix/asgard/wiki) - JFrog’s open-source binary repository management product with support for Apache Maven artifacts.

Line range hint 50-50: Correct the contraction to improve clarity.

-  - [Deis](http://deis.io/) - Open Source Application Platform For Public and Private Clouds. Its built on Docker & CoreOs.
+  - [Deis](http://deis.io/) - Open Source Application Platform For Public and Private Clouds. It's built on Docker & CoreOs.
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 91e15ca and f9e69f2.
Files selected for processing (1)
  • README.md (1 hunks)
Additional Context Used
LanguageTool (30)
README.md (30)

Near line 8: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...s of words related to a specific topic. Also called controlled vocabulary." - [Sourc...


Near line 8: Unpaired symbol: ‘"’ seems to be missing
Context: ...opic. Also called controlled vocabulary." - [Source](http://www.businessdictionar...


Near line 17: Use “An” instead of ‘A’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ... X | Y | Z | # A - AWS - A cl...


Near line 21: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...thub.com/Netflix/asgard/wiki) - JFrog’s open source binary repository management product wi...


Near line 27: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...s://www.elastic.co/products/beats) - An open source collectors for log files, infrastructur...


Near line 33: It appears that hyphens are missing.
Context: ...sed on code reviewing, can support both pre & post commit workflows. # C - [Consul](https://www...


Near line 38: To form a complete sentence, be sure to include a subject.
Context: ...that support containers out of the box. Can be used as base OS to run your own PaaS...


Near line 50: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...Ship, Run. - Deis - Open Source Application Platform For Public and Pri...


Near line 50: Did you mean “it’s” (contraction of “it is/has”)?
Context: ...Platform For Public and Private Clouds. Its built on Docker & CoreOs. - [Drone](ht...


Near line 52: Use “the” before the superlative.
Context: ...ku/dokku) - Docker powered mini-Heroku, a smallest PaaS implementation you've eve...


Near line 54: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...runchbase.com/organization/djangy) - An open source cloud hosting service for Python/Django...


Near line 54: “its” (belonging to it) seems less likely than “it’s” (it is)
Context: ...ing service for Python/Django web apps. Its like Heroku for Python/Django. - [Diam...


Near line 58: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ...cd](https://github.com/coreos/etcd) - A highly-available key value store for shared configuratio...


Near line 59: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...d/helion-eucalyptus-overview.html) - An open source software for building AWS - compatible ...


Near line 64: In American English, abbreviations like “etc.” require a period.
Context: ...kages for multiple platforms (deb, rpm, etc) with great ease and sanity. - [Flynn]...


Near line 65: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ity. - Flynn - An open source PaaS platform built on Docker awesomely...


Near line 71: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...s # G - Git - An awesome tool to version your source code and co...


Near line 75: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... Maven. - Grafana - An open source feature rich metrics dashboard and grap...


Near line 92: This expression is usually spelled with a hyphen.
Context: ...na) - an open source (Apache Licensed), browser based analytic and search dashboard for Elast...


Near line 96: The phrase “a variety of” may be wordy. To make your writing clearer, consider replacing it.
Context: ... process logs and other event data from a variety of systems. - Log.io - ...


Near line 113: Possible missing article found.
Context: ...machines, designed for ground up to run single application, similar to CoreOS. - [Ott...


Near line 115: The adjective “model-driven” is spelled with a hyphen.
Context: ...](https://github.com/tim-group/orc) - A model driven orchestration tool for the deployment o...


Near line 116: To make your text as clear as possible to all readers, do not use this foreign term. Possible alternatives are “below” or “further on” (in a document).
Context: ...skeleton/opskeleton) - Bootstrap DevOps infra with some opinionated defaults(vagrant ...


Near line 148: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...dig](www.sysdig.org/) - An open source, system level exploration: capture system state & act...


Near line 149: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... integration and deployment service for open source and private projects. - [Sublime-Text]...


Near line 156: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...(https://tsuru.io/) - An extensible and open source Platform as a Service; that uses Docker...


Near line 158: Possible spelling mistake found.
Context: ...Integration tool easy to integrate with Github Projects # U # V - [Vagrant](https://www.vagr...


Near line 163: This word is normally spelled with a hyphen.
Context: ...](https://www.vagrantup.com/) - It is a cross platform tool to create, boot, configure and des...


Near line 165: A hyphen is missing in the adjective “built-in”.
Context: ...nux Containers as an alternative to the built in VirtualBox provider for Linux host. - ...


Near line 167: Possible missing article found.
Context: ...PalletOps project turns VirtualBox into light-weight cloud provider. Useful in develo...

Markdownlint (210)
README.md (210)

18: Expected: 0; Actual: 1
Unordered list indentation


19: Expected: 0; Actual: 1
Unordered list indentation


20: Expected: 0; Actual: 1
Unordered list indentation


21: Expected: 0; Actual: 1
Unordered list indentation


22: Expected: 0; Actual: 1
Unordered list indentation


23: Expected: 0; Actual: 1
Unordered list indentation


24: Expected: 0; Actual: 1
Unordered list indentation


27: Expected: 0; Actual: 1
Unordered list indentation


28: Expected: 0; Actual: 1
Unordered list indentation


29: Expected: 0; Actual: 1
Unordered list indentation


30: Expected: 0; Actual: 1
Unordered list indentation


31: Expected: 0; Actual: 1
Unordered list indentation


32: Expected: 0; Actual: 1
Unordered list indentation


33: Expected: 0; Actual: 1
Unordered list indentation


36: Expected: 0; Actual: 1
Unordered list indentation


37: Expected: 0; Actual: 1
Unordered list indentation


38: Expected: 0; Actual: 1
Unordered list indentation


39: Expected: 0; Actual: 1
Unordered list indentation


40: Expected: 0; Actual: 1
Unordered list indentation


41: Expected: 0; Actual: 1
Unordered list indentation


42: Expected: 0; Actual: 1
Unordered list indentation


43: Expected: 0; Actual: 1
Unordered list indentation


44: Expected: 0; Actual: 1
Unordered list indentation


45: Expected: 0; Actual: 1
Unordered list indentation


46: Expected: 0; Actual: 1
Unordered list indentation


49: Expected: 0; Actual: 1
Unordered list indentation


50: Expected: 0; Actual: 1
Unordered list indentation


51: Expected: 0; Actual: 1
Unordered list indentation


52: Expected: 0; Actual: 1
Unordered list indentation


53: Expected: 0; Actual: 1
Unordered list indentation


54: Expected: 0; Actual: 1
Unordered list indentation


55: Expected: 0; Actual: 1
Unordered list indentation


58: Expected: 0; Actual: 1
Unordered list indentation


59: Expected: 0; Actual: 1
Unordered list indentation


62: Expected: 0; Actual: 1
Unordered list indentation


63: Expected: 0; Actual: 1
Unordered list indentation


64: Expected: 0; Actual: 1
Unordered list indentation


65: Expected: 0; Actual: 1
Unordered list indentation


66: Expected: 0; Actual: 1
Unordered list indentation


67: Expected: 0; Actual: 1
Unordered list indentation


68: Expected: 0; Actual: 1
Unordered list indentation


71: Expected: 0; Actual: 1
Unordered list indentation


72: Expected: 0; Actual: 1
Unordered list indentation


73: Expected: 0; Actual: 1
Unordered list indentation


74: Expected: 0; Actual: 1
Unordered list indentation


75: Expected: 0; Actual: 1
Unordered list indentation


76: Expected: 0; Actual: 1
Unordered list indentation


79: Expected: 0; Actual: 1
Unordered list indentation


82: Expected: 0; Actual: 1
Unordered list indentation


85: Expected: 0; Actual: 1
Unordered list indentation


86: Expected: 0; Actual: 1
Unordered list indentation


87: Expected: 0; Actual: 1
Unordered list indentation


90: Expected: 0; Actual: 1
Unordered list indentation


91: Expected: 0; Actual: 1
Unordered list indentation


92: Expected: 0; Actual: 1
Unordered list indentation


93: Expected: 0; Actual: 1
Unordered list indentation


96: Expected: 0; Actual: 1
Unordered list indentation


97: Expected: 0; Actual: 1
Unordered list indentation


98: Expected: 0; Actual: 1
Unordered list indentation


99: Expected: 0; Actual: 1
Unordered list indentation


102: Expected: 0; Actual: 1
Unordered list indentation


103: Expected: 0; Actual: 1
Unordered list indentation


104: Expected: 0; Actual: 1
Unordered list indentation


107: Expected: 0; Actual: 1
Unordered list indentation


110: Expected: 0; Actual: 1
Unordered list indentation


111: Expected: 0; Actual: 1
Unordered list indentation


112: Expected: 0; Actual: 1
Unordered list indentation


113: Expected: 0; Actual: 1
Unordered list indentation


114: Expected: 0; Actual: 1
Unordered list indentation


115: Expected: 0; Actual: 1
Unordered list indentation


116: Expected: 0; Actual: 1
Unordered list indentation


117: Expected: 0; Actual: 1
Unordered list indentation


118: Expected: 0; Actual: 1
Unordered list indentation


121: Expected: 0; Actual: 1
Unordered list indentation


122: Expected: 0; Actual: 1
Unordered list indentation


123: Expected: 0; Actual: 1
Unordered list indentation


124: Expected: 0; Actual: 1
Unordered list indentation


125: Expected: 0; Actual: 1
Unordered list indentation


130: Expected: 0; Actual: 1
Unordered list indentation


131: Expected: 0; Actual: 1
Unordered list indentation


132: Expected: 0; Actual: 1
Unordered list indentation


133: Expected: 0; Actual: 1
Unordered list indentation


134: Expected: 0; Actual: 1
Unordered list indentation


135: Expected: 0; Actual: 1
Unordered list indentation


138: Expected: 0; Actual: 1
Unordered list indentation


139: Expected: 0; Actual: 1
Unordered list indentation


140: Expected: 0; Actual: 1
Unordered list indentation


141: Expected: 0; Actual: 1
Unordered list indentation


142: Expected: 0; Actual: 1
Unordered list indentation


143: Expected: 0; Actual: 1
Unordered list indentation


144: Expected: 0; Actual: 1
Unordered list indentation


145: Expected: 0; Actual: 1
Unordered list indentation


146: Expected: 0; Actual: 1
Unordered list indentation


147: Expected: 0; Actual: 1
Unordered list indentation


148: Expected: 0; Actual: 1
Unordered list indentation


149: Expected: 0; Actual: 1
Unordered list indentation


150: Expected: 0; Actual: 1
Unordered list indentation


151: Expected: 0; Actual: 1
Unordered list indentation


154: Expected: 0; Actual: 1
Unordered list indentation


155: Expected: 0; Actual: 1
Unordered list indentation


156: Expected: 0; Actual: 1
Unordered list indentation


157: Expected: 0; Actual: 1
Unordered list indentation


158: Expected: 0; Actual: 1
Unordered list indentation


163: Expected: 0; Actual: 1
Unordered list indentation


164: Expected: 0; Actual: 1
Unordered list indentation


165: Expected: 0; Actual: 1
Unordered list indentation


166: Expected: 0; Actual: 1
Unordered list indentation


167: Expected: 0; Actual: 1
Unordered list indentation


170: Expected: 0; Actual: 1
Unordered list indentation


177: Expected: 0; Actual: 1
Unordered list indentation


178: Expected: 0; Actual: 1
Unordered list indentation


5: Expected: 1; Actual: 2
Multiple consecutive blank lines


12: Expected: 1; Actual: 2
Multiple consecutive blank lines


180: Expected: 1; Actual: 2
Multiple consecutive blank lines


17: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


26: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


35: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


48: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


57: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


61: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


70: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


78: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


81: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


84: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


89: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


95: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


101: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


106: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


109: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


120: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


129: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


137: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


153: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


162: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


169: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


176: Expected: 1; Actual: 0; Below
Headings should be surrounded by blank lines


17: null
Multiple top-level headings in the same document


26: null
Multiple top-level headings in the same document


35: null
Multiple top-level headings in the same document


48: null
Multiple top-level headings in the same document


57: null
Multiple top-level headings in the same document


61: null
Multiple top-level headings in the same document


70: null
Multiple top-level headings in the same document


78: null
Multiple top-level headings in the same document


81: null
Multiple top-level headings in the same document


84: null
Multiple top-level headings in the same document


89: null
Multiple top-level headings in the same document


95: null
Multiple top-level headings in the same document


101: null
Multiple top-level headings in the same document


106: null
Multiple top-level headings in the same document


109: null
Multiple top-level headings in the same document


120: null
Multiple top-level headings in the same document


127: null
Multiple top-level headings in the same document


129: null
Multiple top-level headings in the same document


137: null
Multiple top-level headings in the same document


153: null
Multiple top-level headings in the same document


160: null
Multiple top-level headings in the same document


162: null
Multiple top-level headings in the same document


169: null
Multiple top-level headings in the same document


172: null
Multiple top-level headings in the same document


174: null
Multiple top-level headings in the same document


176: null
Multiple top-level headings in the same document


18: null
Lists should be surrounded by blank lines


27: null
Lists should be surrounded by blank lines


36: null
Lists should be surrounded by blank lines


49: null
Lists should be surrounded by blank lines


58: null
Lists should be surrounded by blank lines


62: null
Lists should be surrounded by blank lines


71: null
Lists should be surrounded by blank lines


79: null
Lists should be surrounded by blank lines


82: null
Lists should be surrounded by blank lines


85: null
Lists should be surrounded by blank lines


90: null
Lists should be surrounded by blank lines


96: null
Lists should be surrounded by blank lines


102: null
Lists should be surrounded by blank lines


107: null
Lists should be surrounded by blank lines


110: null
Lists should be surrounded by blank lines


121: null
Lists should be surrounded by blank lines


130: null
Lists should be surrounded by blank lines


138: null
Lists should be surrounded by blank lines


154: null
Lists should be surrounded by blank lines


163: null
Lists should be surrounded by blank lines


170: null
Lists should be surrounded by blank lines


177: null
Lists should be surrounded by blank lines


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text


15: null
Spaces inside link text

Additional comments not posted (1)
README.md (1)

6-6: Consider adding a comma for clarity.

- " Alphabetically arranged reference work that gives brief definitions of words related to a specific topic. Also called controlled vocabulary." - [Source](http://www.businessdictionary.com/definition/glossary.html#ixzz3x2CyAJi6)
+ " Alphabetically arranged reference work that gives brief definitions of words related to a specific topic, also called controlled vocabulary." - [Source](http://www.businessdictionary.com/definition/glossary.html#ixzz3x2CyAJi6)

Likely invalid or redundant comment.

@@ -3,7 +3,7 @@
[![Build Status](https://travis-ci.org/TheRemoteLab/devops-glossary.svg?branch=master)](https://travis-ci.org/TheRemoteLab/devops-glossary)


The Complete DevOps Glossary - Covering DevOps from A to Z.
The Complete DevOps Glossary - Covering DevOps from A to Z
Copy link

Choose a reason for hiding this comment

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

Ensure consistency in punctuation.

The removal of the period at the end of the sentence in line 6 should be consistent with the rest of the document. If other similar descriptions end with a period, this one should too.

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.

1 participant