Skip to content

Commit

Permalink
Merge pull request #89 from AlexsLemonade/sjspielman/more-docs-contri…
Browse files Browse the repository at this point in the history
…buting

Expand docs contributing and directories
  • Loading branch information
sjspielman authored Mar 4, 2024
2 parents ac8b7ca + 20ef32f commit 652ab28
Show file tree
Hide file tree
Showing 19 changed files with 37 additions and 2 deletions.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
39 changes: 37 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,42 @@ 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.
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.
If you are adding new images/visual aids for documentation, place them in the `img` directory (not shown in the diagram below).
**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-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)
│ │ └── filing-pull-requests (Filing a PR)
│ │ ├── before-filing (Before filing a PR)
│ │ └── creating-pull-requests (Creating the PR)
│   ├── pr-review-process (PR Review Process)
│ └── merging-prs (Merging a PR)
├── software-platforms (Software tools)
│   ├── aws
│   ├── docker
│   └── lsfr
└── troubleshooting-faq (Getting help & FAQ)
```
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.
Empty file.

0 comments on commit 652ab28

Please sign in to comment.