Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
Have a clear reason: Don’t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it’s necessary and how it improves the project.
Respect existing conventions: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.
Check merged PRs: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
Study rejected PRs: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.
Be descriptive: Your commit messages should clearly describe what the change does and why it was made.
Use the imperative mood: For example, "Add feature X" or "Fix bug in Y", rather than "Added feature X" or "Fixed bug in Y".
Keep commits clean: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.
7. Keep Your Pull Requests (PRs) Small and Focused¶
Make small, targeted PRs: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
Avoid combining unrelated changes: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
Expect feedback: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
Participate in reviews: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.
Test the tool: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
Write well-formed issues: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
Propose reasonable feature requests: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.
- Announcement: This documentation is still in progress.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
FAQ's
-
How do I uninstall LinUtil?
-
-
You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
+ FAQ - Chris Titus LinUtil Official Documentation
You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.
- Announcement: This documentation is still in progress.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Welcome to the LinUtil Documentation!
-
-
-
Running latest release of LinUtil
-
-
You will first need to start a Terminal on your linux machine.
-
Now you will need to run following command:
-
curl -fsSL https://christitus.com/linux | sh
-
-
-
-
Info
-
LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
+ Chris Titus LinUtil Official Documentation
After you've ran the command, you should see a GUI on your screen; It will look something like this:
Info
LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
\ No newline at end of file
diff --git a/roadmap/index.html b/roadmap/index.html
new file mode 100644
index 00000000..79ab7b93
--- /dev/null
+++ b/roadmap/index.html
@@ -0,0 +1 @@
+ Roadmap - Chris Titus LinUtil Official Documentation
Focus on tasks that take time in Linux and automate them. (Example: Removing a user, adding a user, etc. - but mostly BASH scripts with POSIX compliance.)
Remove Binary linutil from being tracked in git and make it a github action.
Document every function and feature of linutil. (Preview panel description addition)
Create a discord server for linutil and invite the community.
Encourage community input and suggestions for future development.
\ No newline at end of file
diff --git a/search/search_index.json b/search/search_index.json
index 82631560..734c2ad1 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-latest-release-of-linutil","title":"Running latest release of LinUtil","text":"
You will first need to start a Terminal on your linux machine.
Now you will need to run following command:
curl -fsSL https://christitus.com/linux | sh\n
Info
LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
"},{"location":"KnownIssues/","title":"Known Issues","text":""},{"location":"contribute/","title":"How to Contribute?","text":""},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":"
You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.
"},{"location":"updates/","title":"Update Log","text":""},{"location":"updates/#_1","title":"Updates","text":""},{"location":"userguide/","title":"Walkthrough","text":""},{"location":"userguide/#how-to-run-linutil","title":"How to run LinUtil?","text":"
Run the following command in a terminal on your Linux System:
curl -fsSL https://christitus.com/linux | sh\n
Once you have run that command you will see the following GUI show on your screen: "}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to the LinUtil Documentation!","text":""},{"location":"#running-the-latest-release-of-linutil","title":"Running the latest release of LinUtil","text":"
To get started, run the following command in your terminal:
After you've ran the command, you should see a GUI on your screen; It will look something like this:
Info
LinUtil is updated weekly as of the time of writing. Consequently, features and functionalities may evolve, and the documentation may not always reflect the most current images or information.
"},{"location":"contribute/","title":"How to Contribute?","text":"
Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
Make sure you have Rust installed on your machine. You can install it by following the instructions at rust-lang.org.
"},{"location":"contribute/#2-fork-and-clone-the-repo","title":"2. Fork and Clone the repo","text":"
Make a fork of the repo in GitHub
Clone the fork bash git clone https://github.com/YOUR_USERNAME_HERE/linutil.git cd linutil
"},{"location":"contribute/#3-make-your-changes","title":"3. Make your changes","text":"
Edit the files you want to change: Make your changes to the relevant files.
Test your changes: Run cargo run to test your modifications in a local environment and ensure everything works as expected.
"},{"location":"contribute/#4-understand-the-existing-code","title":"4. Understand the existing code","text":"
Have a clear reason: Don\u2019t change the way things are done without a valid reason. If you propose an alteration, be prepared to explain why it\u2019s necessary and how it improves the project.
Respect existing conventions: Changes should align with the existing code style, design patterns, and overall project philosophy. If you want to introduce a new way of doing things, justify it clearly.
"},{"location":"contribute/#5-learn-from-past-pull-requests-prs","title":"5. Learn from Past Pull Requests (PRs)","text":"
Check merged PRs: Reviewing merged pull requests can give you an idea of what kind of contributions are accepted and how they are implemented.
Study rejected PRs: This is especially important as it helps you avoid making similar mistakes or proposing changes that have already been considered and declined.
Be descriptive: Your commit messages should clearly describe what the change does and why it was made.
Use the imperative mood: For example, \"Add feature X\" or \"Fix bug in Y\", rather than \"Added feature X\" or \"Fixed bug in Y\".
Keep commits clean: Avoid committing a change and then immediately following it with a fix for that change. Instead, amend your commit or squash it if needed.
"},{"location":"contribute/#7-keep-your-pull-requests-prs-small-and-focused","title":"7. Keep Your Pull Requests (PRs) Small and Focused","text":"
Make small, targeted PRs: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance.
Avoid combining unrelated changes: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
"},{"location":"contribute/#8-code-review-and-feedback","title":"8. Code Review and Feedback","text":"
Expect feedback: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
Participate in reviews: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions.
"},{"location":"contribute/#9-contributing-is-more-than-just-code","title":"9. Contributing Is More Than Just Code","text":"
Test the tool: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
Write well-formed issues: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
Propose reasonable feature requests: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases.
Agree to the license: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
We appreciate your contributions and look forward to collaborating with you to make Linutil better!
"},{"location":"faq/","title":"FAQ's","text":""},{"location":"faq/#how-do-i-uninstall-linutil","title":"How do I uninstall LinUtil?","text":"
You do not have to uninstall LinUtil. As it is a script you run from your terminal it only loads into your RAM. This means as soon as you close LinUtil it will be deleted off your system.
Focus on tasks that take time in Linux and automate them. (Example: Removing a user, adding a user, etc. - but mostly BASH scripts with POSIX compliance.)
Remove Binary linutil from being tracked in git and make it a github action.
Document every function and feature of linutil. (Preview panel description addition)
Create a discord server for linutil and invite the community.
-
-
-
-
-
-
-
-
-
-
-
-
-
-