From bc5d3a543cf57a9679acf9e02da1433b8e088445 Mon Sep 17 00:00:00 2001 From: Shourya Shukla Date: Wed, 26 Feb 2025 11:37:05 +0100 Subject: [PATCH 1/3] Correct instruction set for configuring git * Respect the keyword 'local' while configuring git user names and emails. * Syntax highlight the words 'user.name' and 'user.email' for clarity. --- _docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md b/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md index 97b90519..2c961b63 100644 --- a/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md +++ b/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md @@ -5,10 +5,10 @@ permalink: /docs_v7/Developing-SU2-on-GitHub-(Internal-Developers)/ The repository for SU2 is being hosted here on GitHub. As you are likely aware, GitHub is simply an online project hosting service with a very useful web interface and additional tools to aid code development with Git as its backbone. Git is a version control system (VCS) that is similar to SVN, Mercurial, etc., and it helps organize the development of code over time by tracking changes. -To get started, you need to create a personal user account on GitHub (free) and follow the [basic setup instructions](https://help.github.com/articles/set-up-git). These instructions include how to get Git installed on your local machine. To sync up your local settings with GitHub, change the user.email and user.name variables for your local git configuration with +To get started, you need to create a personal user account on GitHub (free) and follow the [basic setup instructions](https://help.github.com/articles/set-up-git). These instructions include how to get Git installed on your local machine. To sync up your local settings with GitHub, change the `user.email` and `user.name` variables for your local git configuration with ``` -git config --global user.email "your_email@domain.com" -git config --global user.name "Your Name" +git config --local user.email "your_email@domain.com" +git config --local user.name "Your Name" ``` Note that the email address should be the one associated with your GitHub account. From 092513b4ff5ed7792c5213645b5197dad8e76b6b Mon Sep 17 00:00:00 2001 From: Shourya Shukla Date: Wed, 26 Feb 2025 11:38:43 +0100 Subject: [PATCH 2/3] Updated README for developers * Reference the correct files for upcoming changes. Signed-off-by: Shourya Shukla --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 30683b3e..f6bb3996 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ # su2code.github.io [Link to Website](https://su2code.github.io/) + +## For Developers + +In order to make any changes in the documentation of SU2, the files in [_docs_v7/](_docs_v7) should be touched. This is the documentation which is currently online. From dcf0a77046c1b5f9e91b316c6c3b0bb920f2d556 Mon Sep 17 00:00:00 2001 From: Shourya Shukla Date: Wed, 26 Feb 2025 13:03:27 +0100 Subject: [PATCH 3/3] Append reference to setup instructions Signed-off-by: Shourya Shukla --- _docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md | 1 + 1 file changed, 1 insertion(+) diff --git a/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md b/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md index 2c961b63..f14cfdd6 100644 --- a/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md +++ b/_docs_v7/Developing-SU2-on-GitHub-(Internal-Developers).md @@ -22,6 +22,7 @@ After cloning, you should have a new SU2/ folder in your current working directo ``` git log ``` +To setup the local copy of SU2 for development purposes, one must follow the steps mentioned in [Build-SU2-Windows](_docs_v7/Build-SU2-Windows.md) and [Build-SU2-Linux-MacOS](_docs_v7/Build-SU2-Linux-MacOS.md). ## Typical Workflow with Git