Skip to content

Commit

Permalink
Added verbage about storing infusable assets in static/assets
Browse files Browse the repository at this point in the history
  • Loading branch information
riverma committed Aug 30, 2024
1 parent b52ddea commit 07349c8
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/contribute/submit-best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,15 @@ To make it easier for users to adopt your best practice solution, consider prese

Read more about our automation philosophy in [Develop Standards & Best Practices](/slim/docs/about/#2-develop-standards--best-practices).


### Adhere to Folder Structure

To maintain organization and consistency within the repository, create a new folder for your best practice guide. Place this folder within the appropriate sub-folder in the `docs/guides` directory of the [NASA-AMMOS/slim](https://github.com/NASA-AMMOS/slim) repository. Ensure that the folder structure aligns with the type of best practice you are developing, allowing users to easily locate and reference your guide.

Additionally, if your best practice guide includes infusible assets such as templates, code, or any other kind of automation that helps integrate your best practice into projects, you should store these assets within the `/static/assets` directory. Within this directory, create a sub-category that reflects the nature of the assets. This organization allows users to find and utilize the assets more easily, and it aligns with the repository's structure.

For example, if you were to add a new best practice guide related to software-lifecycle security, you'd create a new folder called "my-security-guide" in the below directory:

```
docs/
├── about
Expand All @@ -77,6 +81,18 @@ docs/
└── other-file.jpg
```

And for infusible assets related to this guide, you would store them in a structure like this:

```
static/
├── assets
│ └── software-lifecycle
│ └── security
│ ├── my-security-guide-template.md
│ ├── my-security-script.sh
│ └── my-security-tool-config.json
```

### Use our Standard Guide Template

To maintain uniformity and ease of understanding, contributors are urged to utilize the below template when submitting their best practice guides. This structured format ensures clarity, beginning with a concise title and a one-liner description to capture the essence of the proposal. The Introduction sets the context, Prerequisites identify essential tools or knowledge, and the Step-by-Step Guide offers a methodical walkthrough, enhanced optionally with illustrative images. An FAQ section addresses potential queries, and appropriate credits acknowledge contributors and inspirations. This standard layout not only ensures that each guide retains consistency and comprehensibility, but it also facilitates smoother automation and integration within the SLIM ecosystem.
Expand Down

0 comments on commit 07349c8

Please sign in to comment.