Skip to content

Commit 1691e16

Browse files
Merge pull request #243 from monicagiraldochica/edit_advanceGitGuide
very small update
2 parents 2b3bbbf + 072027a commit 1691e16

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs/software/advanced_git.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,3 +181,7 @@ As merge conflicts get more complicated to resolve, you might need to [reset, ch
181181
[Moving some uncommited changes to a new branch](https://betterstack.com/community/questions/move-uncommited-work-to-new-branch/){:target="_blank"} is another option that would allow you to merge some of the changes that you made and separate the more complicated conflicts into a different branch.
182182

183183
Finally, to investigate further all conflicts, you can [check the list of commits in the repository's history](https://www.freecodecamp.org/news/git-log-command/){:target="_blank"}.
184+
185+
## Professional documentation
186+
187+
You can create a professional static site like this one to host your documentation using [MkDocs](https://www.mkdocs.org/){:target="_blank"} and [MkDocs Material](https://squidfunk.github.io/mkdocs-material/){:target="_blank"}. These will allow you to use customizable themes with advanced navigation and search options.

docs/software/conda.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ The `--keep-env` option leaves the environment intact. Use this option if you'd
129129

130130
Users should avoid mixing conda and non-conda modules in cluster jobs and workflows. For example, a pipeline requiring Python and TensorFlow should use `module load tensorflow` and not `module load tensorflow python`. The first loads the TensorFlow module which is conda based and includes Python already. The second loads the conda-based TensorFlow module and non-conda-based Python module, which may not give the desired version of Python. This simple example can be compounded with job scripts that load many modules.
131131

132-
Users should also avoid using the `conda init` command. If you accidentally setup conda to auto-intialize via your `.bashrc` or `.bash_profile` scripts at login, unintended issues may occur. For example, subsequent module loads may not work, or system commands may conflict with packages within your auto-init conda env. Users that have this issue will see an env name in front of their username at login, i.e. `(myenv) [netid@server ~]`. You can fix this issue with `conda config --set auto_activate_base false`.
132+
Users should also avoid using the `conda init` command. If you accidentally setup conda to auto-initialize via your `.bashrc` or `.bash_profile` scripts at login, unintended issues may occur. For example, subsequent module loads may not work, or system commands may conflict with packages within your auto-init conda env. Users that have this issue will see an env name in front of their username at login, i.e. `(myenv) [netid@server ~]`. You can fix this issue with `conda config --set auto_activate_base false`.
133133

134134
## Additional help
135135

docs/storage/globus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You will setup a new collection, i.e. endpoint. Enter a **Collection Display Nam
1818
![Globus Key Setup](../_static/img/globus-key.png){ width="600" }
1919

2020
!!! warning "As of 5/1/2024, we have identified an issue with Globus producing empty keys with the above step, and they have been notified and are working on the issue."
21-
The workaround is to create the collection and get the setup key via the globus CLI. Run the following in a SSH session on a RCC cluster login node:
21+
The workaround is to create the collection and get the setup key via the Globus CLI. Run the following in a SSH session on a RCC cluster login node:
2222
```bash
2323
module load globusconnect
2424
globus login

0 commit comments

Comments
 (0)