From 28105ed870d0a9e6278276e9e045f01ff1652e42 Mon Sep 17 00:00:00 2001 From: "Stephanie J. Spielman" Date: Mon, 4 Mar 2024 11:51:51 -0500 Subject: [PATCH] Add more instructions to contributing --- docs/contributing.md | 35 +++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index c40953fbd..d0db449e8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -30,7 +30,38 @@ Documentation is written as a series of markdown files nested by topic in direct ## Adding new documentation -_Instructions forthcoming on how to find the right place to add your docs._ +As outlined in [this IA issue](https://github.com/AlexsLemonade/OpenScPCA-analysis/issues/61), we have several sections of documentation. +The diagram below shows the directory structure for the docs, for now considering only the top three directory levels. +The directory names as written in the IA issue are shown in parentheses. -Files and directories should be named with all lowercase letters using `-`, not `_`, where needed. +Each bold bullet point in the IA issue is a directory, and each plain-text bullet is a markdown file. +Consult the IA issue and this directory structure to determine where to place new markdown file. + +If the IA indicates this file should be in an even more nested directory, don't worry about it for now; later, we will add additional nested directores as more documentation comes together. + +Files and directories should be named with all lowercase letters and use `-`, not `_`, where needed. **Be sure to consult the [style guide](./general-style-guide.md) when writing your documentation.** + +``` +├── welcome (Welcome to OpenScPCA) +│  ├── accessing-resources (Getting access to resources) +│  └── getting-started (Getting Started) +├── technical-setup (Setting up) +│   └── environment-setup (Getting access to resources) +├── communications-tools (Communicating within the Project) +│   ├── github-discussions (Github Discussions) +│   └── github-issues (Github Issues) +│   └── writing-issues (Writing good issues) +├── contributing-to-analyses (Contributing to an analysis) +│   ├── analysis-modules (Analysis modules) +│   ├── doing-analyses (Doing an analysis) +│   │   └── working-with-git (Working with git) +│   ├── planning-analyses (Planning your analysis) +│   └── pull-requests (Creating Pull Requests) +├── software-platforms (Software tools) +│   ├── aws +│   ├── docker +│   └── lsfr +└── troubleshooting-faq (Getting help & FAQ) +``` +