-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from t4d-gmbh/17-2nd-proofreading-round-part-4
17 2nd proofreading round part 4
- Loading branch information
Showing
12 changed files
with
117 additions
and
114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,20 @@ | ||
| ## Why Using <i class="fab fa-git"></i> LFS? | ||
| ## Why Use <i class="fab fa-git"></i> LFS? | ||
|
|
||
| {% if build == "pages" %} | ||
| Data management is a critical aspect of scientific research and is often not versioned or tracked leading to data loss, duplication, or errors. | ||
| Effective data management is crucial in scientific research, yet it's often overlooked, leading to data loss, duplication, or errors. | ||
|
|
||
| Tracking large files with <i class="fab fa-git"></i> can be challenging. | ||
| As the size of your repository grows, it can slows down the <i class="fab fa-git"></i> operations, such as cloning, fetching, and pushing because <i class="fab fa-git"></i> stores the entire history of the repository locally. | ||
| To address this issue, <i class="fab fa-git"></i> Large File Storage (LFS) provides a solution for managing large files in your <i class="fab fa-git"></i> repositories. | ||
| As the size of your repository grows, operations like cloning, fetching, and pushing can slow down because <i class="fab fa-git"></i> stores the entire repository's history locally. | ||
| To address this, <i class="fab fa-git"></i> Large File Storage (LFS) provides a solution for managing large files in your <i class="fab fa-git"></i> repositories. | ||
|
|
||
| Git Large File Storage (LFS) is a <i class="fab fa-git"></i> extension that replaces large files in your repository with text pointers while storing the file contents on a remote server. | ||
| This approach allows you to work with large files in your repository without slowing down the <i class="fab fa-git"></i> operations. | ||
| <i class="fab fa-git"></i>-LFS is an extension that replaces large files in your repository with lightweight text pointers, while the actual file contents are stored on a remote server. | ||
| This allows you to work with large files without affecting <i class="fab fa-git"></i> performance. | ||
|
|
||
| {% else %} | ||
|
|
||
| - **Data Management**: Proper data management is crucial in scientific research to prevent data loss, duplication, and errors. | ||
| - **Data Management**: Proper data management is essential to avoid data loss, duplication, and errors in scientific research. | ||
| - **Efficiency**: Traditional <i class="fab fa-git"></i> struggles with large files, leading to slow performance and bloated repositories. | ||
| - **Collaboration**: Ensures team members can work with large files without conflicts or performance issues. | ||
| - **History Tracking**: Maintains a history of changes, making it easier to revert to previous versions if needed. | ||
| - **Collaboration**: Enables team members to handle large files without conflicts or performance issues. | ||
| - **History Tracking**: Maintains a history of changes, making it easier to revert to previous versions when needed. | ||
|
|
||
| {% endif %} |
49 changes: 29 additions & 20 deletions
49
source/content/project_mgmt_tools/key_features_and_benefits.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,59 @@ | ||
| ## Key Features and Benefits | ||
| :::{card} | ||
| **Version Control with <i class="fab fa-git"></i>'s Feature Branch Workflow** {% if page %} | ||
| GitHub<i class="fab fa-github"></i> and GitHub<i class="fab fa-gitlab"></i> allow teams to track changes, revert to previous versions, and collaborate on code seamlessly. | ||
| ### Version Control with <i class="fab fa-git"></i>'s Feature Branch Workflow | ||
| {% if page %} | ||
| GitHub<i class="fab fa-github"></i> and GitHub<i class="fab fa-gitlab"></i> allow teams to track changes, revert to previous versions, and collaborate seamlessly on code. | ||
| This ensures that all modifications are documented, which is crucial for **transparency and accountability**. | ||
| {% else %} | ||
| Track changes, revert to previous versions, etc. crucial for **transparency and accountability**. | ||
| Track changes, revert to previous versions, and seamless collaboration are crucial for **transparency and accountability**. | ||
| {% endif %} | ||
| ::: | ||
|
|
||
| :::{card} | ||
| **Issue{octicon}`issue-opened;0.8em` Tracking** {% if page %} | ||
| Issues help manage tasks, bugs, and feature requests. | ||
| By documenting issues and their resolutions, teams can maintain a clear record of project progress and decision-making processes. | ||
|
|
||
| ### Issue Tracking | ||
| {% if page %} | ||
| Issues help teams to manage tasks, bugs, and feature requests efficiently. By documenting issues and their resolutions, teams can keep a clear record of project progress and decision-making processes. | ||
| {% else %} | ||
| Maintain a clear record of project progress and decision-making processes. | ||
| Efficiently manage tasks, bugs, and feature requests, while maintaining a clear record of project progress and decision-making. | ||
| {% endif %} | ||
| ::: | ||
|
|
||
| :::{card} | ||
| **Code Review** {% if page %} | ||
| Pull (<i class="fab fa-github"></i>) and Merge Requests (<i class="fab fa-gitlab"></i>) facilitate peer review of code changes before they are integrated into the main codebase. Code reviews help catch errors, enforce coding standards, and ensure that contributions meet the project’s quality requirements. | ||
|
|
||
| ### Code Review | ||
| {% if page %} | ||
| Pull (<i class="fab fa-github"></i>) and Merge Requests (<i class="fab fa-gitlab"></i>) facilitate peer review of code changes before they are integrated into the main codebase. Code reviews help catch errors, enforce coding standards, and ensure that contributions meet the project’s quality standards. | ||
| {% else %} | ||
| Help catch errors, enforce coding standards, and ensure contributions meet quality requirements. | ||
| <i class="fab fa-git"></i> tools help catch errors, enforce coding standards, and ensure contributions meet quality requirements. | ||
| {% endif %} | ||
| ::: | ||
|
|
||
| :::{card} | ||
| **Continuous Integration/Continuous Deployment (CI/CD)** {% if page %} | ||
| GitHub<i class="fab fa-github"></i> Actions and GitHub<i class="fab fa-gitlab"></i> CI/CD provide automated testing and deployment pipelines to ensure that code changes are tested and validated before being merged. This reduces the risk of introducing errors and ensures that the codebase remains stable and reliable. | ||
|
|
||
| ### Continuous Integration/Continuous Deployment (CI/CD) | ||
| {% if page %} | ||
| GitHub<i class="fab fa-github"></i> Actions and GitLab<i class="fab fa-gitlab"></i> CI/CD provide automated testing and deployment pipelines. These tools ensure that code changes are tested and validated before being merged, reducing risk of introducing errors and ensuring that the codebase remains stable and reliable. | ||
| {% else %} | ||
| Reduce risk of errors and ensure codebase stability. | ||
| Automated testing and deployment pipelines reduce risk of errors and ensure codebase stability. | ||
| {% endif %} | ||
| ::: | ||
|
|
||
| :::{card} | ||
| **Documentation** {% if page %} | ||
| Wikis and README Files on both platforms support extensive documentation. Proper documentation is essential for reproducibility, allowing others to understand and replicate the work. | ||
| ### Documentation | ||
| {% if page %} | ||
| Wikis and README files on both platforms support comprehensive documentation. Proper documentation is essential for reproducibility, allowing others to understand and replicate the work. | ||
| {% else %} | ||
| Essential for reproducibility, allowing others to understand and replicate the work. | ||
| Comprehensive documentation is essential for reproducibility, allowing others to understand and replicate the work. | ||
| {% endif %} | ||
| ::: | ||
|
|
||
| :::{card} | ||
| **Collaboration and Communication** {% if page %} | ||
| Comments and Discussions on GitHub<i class="fab fa-github"></i> and GitHub<i class="fab fa-gitlab"></i> provide features for commenting on code, issues, and merge requests. This facilitates communication among team members, ensuring that everyone is on the same page and that decisions are well-documented. | ||
|
|
||
| ### Collaboration and Communication | ||
| {% if page %} | ||
| Comments and Discussions on GitHub<i class="fab fa-github"></i> and GitLab<i class="fab fa-gitlab"></i> faciliate communication by allowing users to comment on code, issues, and merge requests. This ensures that team members stay aligned and that key decisions are well-documented. | ||
| {% else %} | ||
| Facilitate communication among team members, ensuring everyone is on the same page and decisions are well-documented. | ||
| Facilitate communication by enabling comments on code, issues, and merge requests, keeping team members aligned and ensuring key decisions are well documented. | ||
| {% endif %} | ||
| ::: | ||
| ::: |
Oops, something went wrong.