Added solution.md for Day 02: Basic Linux Commands with Sample Output Images #318
Conversation
|
Review my commit |
|
@coderabbitai full review |
✅ Actions performedFull review triggered. |
WalkthroughThe changes consist of a detailed guide on basic Linux commands, emphasizing listing and directory commands. It includes explanations and examples for various Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant LinuxCommands
participant Documentation
User->>Documentation: Access guide
Documentation->>LinuxCommands: Display command list
LinuxCommands-->>Documentation: Provide command details
Documentation-->>User: Show command explanations and examples
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
2024/day02/solution.md (3)
1-3: Improve document structure consistencyThe document structure could be improved in the following ways:
- Consolidate or differentiate the multiple "Examples:" sections
- Maintain consistent heading levels throughout the document
Consider this structure:
## Basic Linux Commands ### Listing Commands #### Basic Usage #### Advanced Examples ### Directory Commands #### Basic Usage #### Advanced ExamplesAlso applies to: 18-19, 85-86, 187-188
206-206: Improve clarity of hidden directory descriptionThe description of making hidden directories could be clearer.
-Make a hidden directory (also . before a file to make it hidden). +Make a hidden directory by prefixing the name with a dot (.). This same technique can be used to create hidden files.🧰 Tools
🪛 LanguageTool
[style] ~206-~206: The adverb ‘also’ is commonly used to connect clauses and isn’t usually used at the end of a phrase or before a conjunction. Consider replacing it with a more formal alternative.
Context: ... ``` - #### Make a hidden directory (also . before a file to make it hidden). ##...(ALSO_AS_WELL)
🪛 Markdownlint
206-206: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
13-13: Improve image naming conventionThe current image naming convention has several issues:
- Filenames contain spaces and special characters which could cause problems
- Generic screenshot names make maintenance difficult
- No clear connection between image names and the commands they represent
Consider renaming images to follow this pattern:
./images/command-name-example.png Examples: ./images/ls-basic-output.png ./images/ls-l-long-format.png ./images/mkdir-multiple-dirs.pngAlso applies to: 28-28, 41-41, 54-54, 67-67, 80-80, 95-95, 108-108, 126-126, 130-130, 143-143, 156-156, 169-169, 182-182, 197-197, 210-210, 223-223, 236-236, 249-249, 253-253
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
⛔ Files ignored due to path filters (20)
2024/day02/images/Screenshot 2024-10-10 175519.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175531.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175558.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175830.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175853.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175920.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 175934.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180007.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180104.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180120.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180145.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180259.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180356.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180434.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180513.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180544.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 180615.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 181323.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 181434.pngis excluded by!**/*.png2024/day02/images/Screenshot 2024-10-10 181655.pngis excluded by!**/*.png
📒 Files selected for processing (1)
- 2024/day02/solution.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
2024/day02/solution.md
[style] ~206-~206: The adverb ‘also’ is commonly used to connect clauses and isn’t usually used at the end of a phrase or before a conjunction. Consider replacing it with a more formal alternative.
Context: ... ``` - #### Make a hidden directory (also . before a file to make it hidden). ##...(ALSO_AS_WELL)
🪛 Markdownlint
2024/day02/solution.md
24-24: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
193-193: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
39-39: null
Multiple headings with the same content(MD024, no-duplicate-heading)
52-52: null
Multiple headings with the same content(MD024, no-duplicate-heading)
65-65: null
Multiple headings with the same content(MD024, no-duplicate-heading)
78-78: null
Multiple headings with the same content(MD024, no-duplicate-heading)
106-106: null
Multiple headings with the same content(MD024, no-duplicate-heading)
141-141: null
Multiple headings with the same content(MD024, no-duplicate-heading)
154-154: null
Multiple headings with the same content(MD024, no-duplicate-heading)
167-167: null
Multiple headings with the same content(MD024, no-duplicate-heading)
180-180: null
Multiple headings with the same content(MD024, no-duplicate-heading)
187-187: null
Multiple headings with the same content(MD024, no-duplicate-heading)
208-208: null
Multiple headings with the same content(MD024, no-duplicate-heading)
221-221: null
Multiple headings with the same content(MD024, no-duplicate-heading)
234-234: null
Multiple headings with the same content(MD024, no-duplicate-heading)
247-247: null
Multiple headings with the same content(MD024, no-duplicate-heading)
9-9: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
11-11: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
18-18: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
24-24: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
26-26: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
37-37: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
39-39: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
50-50: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
52-52: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
63-63: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
65-65: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
76-76: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
91-91: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
93-93: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
104-104: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
106-106: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
122-122: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
124-124: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
128-128: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
139-139: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
141-141: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
152-152: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
154-154: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
165-165: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
167-167: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
178-178: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
180-180: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
187-187: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
193-193: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
195-195: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
206-206: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
208-208: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
219-219: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
221-221: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
232-232: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
234-234: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
245-245: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
247-247: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
251-251: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
🔇 Additional comments (1)
2024/day02/solution.md (1)
1-255: Overall feedback on the Linux commands guideThis is a comprehensive and well-structured guide that will be valuable for beginners learning Linux commands. The inclusion of sample outputs with images is particularly helpful for understanding command behavior.
While the content is solid, addressing the formatting and structure issues mentioned above will improve the document's maintainability and readability for future contributors.
Let's verify the image paths are valid:
✅ Verification successful
Let me verify the local image paths in the repository structure.
All image paths in the Linux commands guide are valid and properly organized
The verification shows that:
- The
imagesdirectory exists at the correct location:2024/day02/images/- All screenshot images referenced in the markdown file are present in the images directory with matching filenames
- The relative paths used in the markdown (./images/...) correctly point to the actual image locations
The documentation's image references are properly structured and all required images are available in the repository.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if all referenced images exist for img in $(rg -o '!\[.*?\]\((.*?)\)' | cut -d'(' -f2 | cut -d')' -f1); do if [ ! -f "${img#./}" ]; then echo "Missing image: $img" fi doneLength of output: 66391
Script:
#!/bin/bash # Check if the images directory exists and contains the referenced screenshots fd -t d "images$" . echo "---" fd -t f "Screenshot.*\.png" .Length of output: 1206
🧰 Tools
🪛 LanguageTool
[style] ~206-~206: The adverb ‘also’ is commonly used to connect clauses and isn’t usually used at the end of a phrase or before a conjunction. Consider replacing it with a more formal alternative.
Context: ... ``` - #### Make a hidden directory (also . before a file to make it hidden). ##...(ALSO_AS_WELL)
🪛 Markdownlint
24-24: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
193-193: Expected: h3; Actual: h4
Heading levels should only increment by one level at a time(MD001, heading-increment)
39-39: null
Multiple headings with the same content(MD024, no-duplicate-heading)
52-52: null
Multiple headings with the same content(MD024, no-duplicate-heading)
65-65: null
Multiple headings with the same content(MD024, no-duplicate-heading)
78-78: null
Multiple headings with the same content(MD024, no-duplicate-heading)
106-106: null
Multiple headings with the same content(MD024, no-duplicate-heading)
141-141: null
Multiple headings with the same content(MD024, no-duplicate-heading)
154-154: null
Multiple headings with the same content(MD024, no-duplicate-heading)
167-167: null
Multiple headings with the same content(MD024, no-duplicate-heading)
180-180: null
Multiple headings with the same content(MD024, no-duplicate-heading)
187-187: null
Multiple headings with the same content(MD024, no-duplicate-heading)
208-208: null
Multiple headings with the same content(MD024, no-duplicate-heading)
221-221: null
Multiple headings with the same content(MD024, no-duplicate-heading)
234-234: null
Multiple headings with the same content(MD024, no-duplicate-heading)
247-247: null
Multiple headings with the same content(MD024, no-duplicate-heading)
9-9: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
11-11: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
18-18: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
24-24: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
26-26: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
37-37: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
39-39: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
50-50: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
52-52: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
63-63: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
65-65: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
76-76: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
78-78: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
91-91: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
93-93: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
104-104: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
106-106: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
122-122: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
124-124: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
128-128: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
139-139: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
141-141: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
152-152: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
154-154: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
165-165: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
167-167: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
178-178: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
180-180: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
187-187: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
193-193: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
195-195: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
206-206: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
208-208: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
219-219: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
221-221: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
232-232: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
234-234: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
245-245: Punctuation: '.'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
247-247: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
251-251: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
|
|
||
| - #### List the subdirectories and files available in the present directory. | ||
|
|
||
| #### Sample output image: |
There was a problem hiding this comment.
Fix markdown formatting issues
Several markdown formatting issues need to be addressed:
- Remove trailing punctuation from headings
- Use consistent heading levels
- Avoid duplicate heading content
Apply these changes:
- Remove colons from "Sample output image" headings
- Use unique heading content or combine related images under a single heading
- Ensure heading levels increment by only one level at a time
Example format:
### Command Category
#### Command Name
Description of the command
#### Examples
Command example with explanation
#### Output
Also applies to: 26-26, 39-39, 52-52, 65-65, 78-78, 93-93, 106-106, 124-124, 128-128, 141-141, 154-154, 167-167, 180-180, 195-195, 208-208, 221-221, 234-234, 247-247, 251-251
🧰 Tools
🪛 Markdownlint
11-11: Punctuation: ':'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
Description:
This pull request adds the
solution.mdfile for Day 02 of the 90DaysOfDevOps challenge. The file provides an overview of basic Linux commands along with sample output images for better understanding. It covers commands likels,pwd,cd,mkdir, and more. Each command is explained with examples, followed by corresponding output images to help beginners visualize command execution.Key changes:
This contribution aims to make Day 02 of the 90DaysOfDevOps challenge easier for beginners to follow.
Summary by CodeRabbit
lsand directory commands.