From 4f25a7c8dd01dfdbfcbc30937dc8ce33f607c723 Mon Sep 17 00:00:00 2001 From: kaelyndunnell Date: Mon, 4 Nov 2024 11:19:46 -0500 Subject: [PATCH 1/2] Updated What do I need to Know section of user guide to reflect that a git account is not needed for latest updates of the code. --- docs/source/userguide/beginners_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index fcc1eefad..fc3fec807 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -10,7 +10,7 @@ Basic knowledge of `Python `_ is required to make New users should familiarise themselves with `Conda `_. -FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to understand how it works. You can find `git tutorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Signing up for free to GitHub is recommended to receive the latest updates, follow the development and submit `bug reports `_. +FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git turorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and `contribute to the code. `_ ---------------------- Where can I find help? From ebc316833c03a3e701e14e95e602a2de16ee1a75 Mon Sep 17 00:00:00 2001 From: RemDelaporteMathurin Date: Mon, 4 Nov 2024 12:00:22 -0500 Subject: [PATCH 2/2] minor changes --- docs/source/devguide/index.rst | 2 ++ docs/source/userguide/beginners_guide.rst | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/devguide/index.rst b/docs/source/devguide/index.rst index b82e304ac..80b00d570 100644 --- a/docs/source/devguide/index.rst +++ b/docs/source/devguide/index.rst @@ -1,3 +1,5 @@ +.. _developers_guide: + ================= Developer's Guide ================= diff --git a/docs/source/userguide/beginners_guide.rst b/docs/source/userguide/beginners_guide.rst index fc3fec807..c0ebcb421 100644 --- a/docs/source/userguide/beginners_guide.rst +++ b/docs/source/userguide/beginners_guide.rst @@ -10,7 +10,8 @@ Basic knowledge of `Python `_ is required to make New users should familiarise themselves with `Conda `_. -FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git turorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. Git knowledge and a GitHub account is required to open issues and `contribute to the code. `_ +FESTIM is under version control with `git `_. Even though users don't need git to install FESTIM, it is convenient to have a basic understanding of how it works. You can find `git tutorials `_ to help you getting started. The `FESTIM source code `_ is hosted on GitHub. +Git knowledge and a GitHub account is required to open issues and :ref:`contribute to the code `. ---------------------- Where can I find help?