Skip to content

Commit

Permalink
Merge branch 'reproducibility-docs' into sjspielman/497-update-docker…
Browse files Browse the repository at this point in the history
…-images
  • Loading branch information
sjspielman authored Jun 26, 2024
2 parents 930462e + f4810f8 commit c119100
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 7 deletions.
1 change: 1 addition & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ jobs:
# Capture all the bad links (don't let grep exit -1 if no match)
grep "relative link" build-log.txt > bad_links.txt || true
grep "no such anchor" build-log.txt >> bad_links.txt || true
# Save the number of bad links to github output
echo "n_bad_links=$(wc -l < bad_links.txt)" >> "$GITHUB_OUTPUT"
Expand Down
2 changes: 1 addition & 1 deletion docs/aws/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ All contributors will have a designated [researcher bucket](working-with-s3-buck
Please refer to these pages about working with S3:

- [Configuring and logging into AWS from the command line](../technical-setup/environment-setup/configure-aws-cli.md)
- [Accessing project data from S3](../getting-started/accessing-resources/getting-access-to-data.md#accessing-data-on-s3)
- [Accessing project data from S3](../getting-started/accessing-resources/getting-access-to-data.md#accessing-data-from-s3)
- [Using your researcher bucket](working-with-s3-buckets.md)

## Lightsail for Research: Virtual computing with AWS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ We have found that following some common patterns can enhance sharing and reprod
- Use headings and subheadings to break up the analysis into logical sections.
- **Session info**: Print out the versions of all packages used in the analysis.

Below we provide more detail about each of these sections for [R Markdown](#r-markdown-notebooks) and [Jupyter](#python-notebooks) notebooks.
Below we provide more detail about each of these sections for [R Markdown](#r-markdown-notebooks) and [Jupyter](#jupyter-notebooks) notebooks.

## R Markdown notebooks

Expand Down
2 changes: 1 addition & 1 deletion docs/ensuring-repro/managing-software/using-conda.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You should perform this step before [filing a pull request](../../contributing-t
If the `conda-lock` command fails, it may be because a package is not available for one of the platforms listed in the `environment.yml` file.
Usually this will be a package that is not available for the `osx-arm64` (Apple Silicon) platform.

If this happens, see the [Software not available on a specific platform](#software-not-available-on-a-specific-platform) section below for instructions on how to handle this situation.
If this happens, see the [Software not available on a specific platform](#adding-dependencies-not-available-on-a-specific-platform) section below for instructions on how to handle this situation.

## Adding packages to the environment

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/project-tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Therefore, as a contributor, there are several tools you will need to be familia
- [This documentation section](../../contributing-to-analyses/working-with-git/index.md) explains how to use Git as a contributor, specifically using the [GitKraken GUI](../../technical-setup/install-a-git-client.md#why-use-gitkraken)
- The [terminal](./using-the-terminal.md), also known as the command line
- Writing text in [markdown](./writing-in-markdown.md)
- Software management platforms, including [conda](#STUB_LINK conda software page) and, if you plan to develop R-based modules, [`renv`](#STUB_LINK renv software page)
- Software management platforms, including [conda](../../ensuring-repro/managing-software/using-conda.md) and, if you plan to develop R-based modules, [`renv`](../../ensuring-repro/managing-software/using-renv.md)

!!! tip

Expand Down
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
mkdocs-material==9.5.10
mkdocs==1.5.3
mkdocs-material==9.5.27
mkdocs==1.6.0
2 changes: 1 addition & 1 deletion docs/technical-setup/install-wsl-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Open it by clicking "Run as administrator".
You will need to use your password when installing software for Ubuntu, and if you choose to use [RStudio](environment-setup/install-r-rstudio.md#using-the-rstudio-server), you will need your username and password.
- Note that when you type your password, no symbols will appear - this is expected!

1. Open an [Ubuntu terminal window](../getting-started/project-tools/using-the-terminal.md#accessing-the-terminal-on-wsl2-on-windows).
1. Open an [Ubuntu terminal window](../getting-started/project-tools/using-the-terminal.md#accessing-the-terminal-on-wsl-2-on-windows).

- Run the following command in Ubuntu to ensure that the package index for `apt`, the native Ubuntu package manager, and all its pre-installed packages are up to date.
- Ubuntu will prompt you for your newly-created password when you run this command; you can expect to be prompted for a password any time you run a command as [`sudo`](https://www.pluralsight.com/resources/blog/cloud/linux-commands-for-beginners-sudo).
Expand Down

0 comments on commit c119100

Please sign in to comment.