From 85eaae001b766b65aaa583423468f9b7ac7357c3 Mon Sep 17 00:00:00 2001 From: Ally Hawkins <54039191+allyhawkins@users.noreply.github.com> Date: Wed, 13 Mar 2024 12:59:26 -0500 Subject: [PATCH 1/5] add stub for working with git --- .../doing-analyses/working-with-git/index.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/contributing-to-analyses/doing-analyses/working-with-git/index.md diff --git a/docs/contributing-to-analyses/doing-analyses/working-with-git/index.md b/docs/contributing-to-analyses/doing-analyses/working-with-git/index.md new file mode 100644 index 000000000..927b44ec2 --- /dev/null +++ b/docs/contributing-to-analyses/doing-analyses/working-with-git/index.md @@ -0,0 +1,5 @@ +# Working with Git + +_This content is a stub._ + +This section includes information about working with Git while contributing to OpenScPCA. From e42f4ce2bd89392ed77873b42c2a565c5a356705 Mon Sep 17 00:00:00 2001 From: Ally Hawkins Date: Wed, 13 Mar 2024 13:10:20 -0500 Subject: [PATCH 2/5] stub in doing-analyses to get correct directory structure --- docs/contributing-to-analyses/doing-analyses/index.md | 5 +++++ mkdocs.yml | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 docs/contributing-to-analyses/doing-analyses/index.md diff --git a/docs/contributing-to-analyses/doing-analyses/index.md b/docs/contributing-to-analyses/doing-analyses/index.md new file mode 100644 index 000000000..06ddd0b62 --- /dev/null +++ b/docs/contributing-to-analyses/doing-analyses/index.md @@ -0,0 +1,5 @@ +# Doing an analyss + +_This content is a stub._ + +This section includes information about doing an analyses, including creating a new module and working with Git. diff --git a/mkdocs.yml b/mkdocs.yml index c556c9e16..b15077cc2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,6 +46,10 @@ nav: - communications-tools/index.md - Contributing to analyses: # Setting up an analysis, all the git stuff - contributing-to-analyses/index.md + - Doing-analyses: + - contributing-to-analyses/index.md + - Working with Git: # Creating branches, adding commits, all git interactions + - contributing-to-analyses/doing-analyses/working-with-git/index.md - Software platforms: # LSfR, AWS, Docker, etc - software-platforms/index.md - Getting Help and FAQ: # troubleshooting and FAQ From 7fb6d6f9631d3b8866ee152216228d5e4a7c4b88 Mon Sep 17 00:00:00 2001 From: Ally Hawkins Date: Wed, 13 Mar 2024 13:12:37 -0500 Subject: [PATCH 3/5] spell analyses --- docs/contributing-to-analyses/doing-analyses/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing-to-analyses/doing-analyses/index.md b/docs/contributing-to-analyses/doing-analyses/index.md index 06ddd0b62..3cebe4727 100644 --- a/docs/contributing-to-analyses/doing-analyses/index.md +++ b/docs/contributing-to-analyses/doing-analyses/index.md @@ -1,4 +1,4 @@ -# Doing an analyss +# Doing an analyses _This content is a stub._ From ac702aef95fe3c9517710f4a2893a837cffb445f Mon Sep 17 00:00:00 2001 From: Ally Hawkins <54039191+allyhawkins@users.noreply.github.com> Date: Wed, 13 Mar 2024 14:40:11 -0500 Subject: [PATCH 4/5] Apply suggestions from code review Co-authored-by: Stephanie Spielman --- docs/contributing-to-analyses/doing-analyses/index.md | 2 +- mkdocs.yml | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contributing-to-analyses/doing-analyses/index.md b/docs/contributing-to-analyses/doing-analyses/index.md index 3cebe4727..5ed40dcba 100644 --- a/docs/contributing-to-analyses/doing-analyses/index.md +++ b/docs/contributing-to-analyses/doing-analyses/index.md @@ -1,4 +1,4 @@ -# Doing an analyses +# Doing an analysis _This content is a stub._ diff --git a/mkdocs.yml b/mkdocs.yml index b15077cc2..3c116b109 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -46,8 +46,8 @@ nav: - communications-tools/index.md - Contributing to analyses: # Setting up an analysis, all the git stuff - contributing-to-analyses/index.md - - Doing-analyses: - - contributing-to-analyses/index.md + - Doing an analysis: + - contributing-to-analyses/doing-analyses/index.md - Working with Git: # Creating branches, adding commits, all git interactions - contributing-to-analyses/doing-analyses/working-with-git/index.md - Software platforms: # LSfR, AWS, Docker, etc From b109c007137092e3476411bdc88097e0639c8d52 Mon Sep 17 00:00:00 2001 From: Ally Hawkins Date: Wed, 13 Mar 2024 17:17:45 -0500 Subject: [PATCH 5/5] remove navigation sections --- mkdocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 3c116b109..92d45b369 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -14,7 +14,6 @@ theme: - search.suggest # displays in light gray how you might complete the word - navigation.tabs # persistent navbar on the top - navigation.tabs.sticky # sticky navbar - - navigation.sections # enables sections along the left side bar via nested directories in docs/ - navigation.indexes # allow index pages to serve as overview pages for sections plugins: