Skip to content

Commit

Permalink
move pre-req to a collapsible section
Browse files Browse the repository at this point in the history
  • Loading branch information
PedramNavid committed Aug 13, 2024
1 parent fee23c4 commit 9dd1147
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 13 deletions.
10 changes: 7 additions & 3 deletions docs/docs-next/src/templates/concept.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,20 @@ Using [TOPIC] helps you:

---

## Prerequisites

<!-- This section lists the prerequisites users must complete before they should/can proceed. For concepts, we should list the other concepts they should be familiar with first. -->

Before continuing, you should be familiar with:
<details>
<summary>Prerequisites</summary>

To follow the steps in this guide, you'll need:

- A basic understanding of Dagster concepts such as assets and resources
<!-- - Ex: To use asset checks, users should understand Asset definitions first
- Another one
- One more -->

</details>

---

## How it works
Expand Down
14 changes: 9 additions & 5 deletions docs/docs-next/src/templates/guide-no-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,19 @@ By the end of this guide, you will [a sentence or list about what will be achiev

---

## Prerequisites
<!-- This section lists the prerequisites users must complete before they should/can proceed. For concepts, we should list the other concepts they should be familiar with first. -->

<!-- This section lists the prerequisites users must complete before they should/can proceed with the guide. -->
<details>
<summary>Prerequisites</summary>

To follow the steps in this guide, you'll need:

- A prerequisite, ex: "Familiarity with Asset definitions"
- Another prerequisite, ex: "To install <this> library"
- One more
- A basic understanding of Dagster concepts such as assets and resources
<!-- - Ex: To use asset checks, users should understand Asset definitions first
- Another one
- One more -->

</details>

---

Expand Down
15 changes: 10 additions & 5 deletions docs/docs-next/src/templates/guide-with-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,20 @@ By the end of this guide, you will [a sentence or list about what will be achiev

---

## Prerequisites
<!-- This section lists the prerequisites users must complete before they should/can proceed. For concepts, we should list the other concepts they should be familiar with first. -->

<!-- This section lists the prerequisites users must complete before they should/can proceed with the guide. -->
<details>
<summary>Prerequisites</summary>

To follow the steps in this guide, you'll need:

- A prerequisite, ex: "Familiarity with Asset definitions"
- Another prerequisite, ex: "To install <this> library"
- One more
- A basic understanding of Dagster concepts such as assets and resources
<!-- - Ex: To use asset checks, users should understand Asset definitions first
- Another one
- One more -->

</details>


---

Expand Down

0 comments on commit 9dd1147

Please sign in to comment.