Skip to content

Commit eb0fbc5

Browse files
github-actions[bot]github-actions[bot]
authored
Merge pull request #625 from validmind/update-staging-12718099842
Merge main into staging
2 parents 2ab0e30 + 56e0a9f commit eb0fbc5

21 files changed

Lines changed: 61 additions & 62 deletions

‎release-scripts/generate-release-notes.ipynb‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@
222222
"\n",
223223
"### Create release folder and file\n",
224224
"\n",
225-
"These lines will create a folder inside of `~/site/releases` for the release notes with a new `release-notes.qmd` file. The folder name is the release date, as per our convention. \n",
225+
"These lines will create a folder inside of `~/site/releases` for the new release notes to live in and sets stage for the release notes to be generated. The folder name is the release date, as per our convention. \n",
226226
"\n",
227-
"**If the directory and file already exists, you will be prompted to confirm whether or not you want to overwrite the contents.**"
227+
"**If the directory and release file already exists, you will be prompted to confirm whether or not you want to overwrite the contents.**"
228228
]
229229
},
230230
{
@@ -243,7 +243,9 @@
243243
"<a id='toc3_2_'></a>\n",
244244
"\n",
245245
"### Add the date to release notes \n",
246-
"This block writes the specified date as the title of the new release notes file."
246+
"This block writes the specified date as the title of the new release notes file.\n",
247+
"\n",
248+
"**It will also open up the newly created `release-notes.qmd` file for you so you don't have to go looking for it.**"
247249
]
248250
},
249251
{

‎release-scripts/generate_release_objects.py‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,7 @@ def create_release_folder(formatted_release_date):
453453
# Create directory and output file
454454
os.makedirs(directory_path, exist_ok=True)
455455
print(f"{output_file} will be created or overwritten")
456+
456457
return output_file
457458

458459
def create_release_qmd(output_file, original_release_date):
@@ -468,6 +469,11 @@ def create_release_qmd(output_file, original_release_date):
468469
with open(output_file, "w") as file:
469470
file.write(f"---\ntitle: \"{original_release_date}\"\n---\n\n")
470471

472+
try:
473+
subprocess.run(["code", output_file], check=True)
474+
except Exception as e:
475+
print(f"Error opening the file in VS Code: {e}")
476+
471477
def update_release_components(release_components, categories):
472478
"""
473479
Updates a dictionary of release components with the given categories.

‎release-scripts/year-end-cleanup.ipynb‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,9 @@
203203
"\n",
204204
"### Create yearly listing page \n",
205205
"\n",
206-
"This cell copies the template from `~internal/templates/yearly-releases.qmd` and slots it into the new yearly folder as `{year}-releases.qmd` so we can begin building the yearly listings."
206+
"This cell copies the template from `~internal/templates/yearly-releases.qmd` and slots it into the new yearly folder as `{year}-releases.qmd` so we can begin building the yearly listings.\n",
207+
"\n",
208+
"**It will also open up the newly created `{year}-releases.qmd` file for you so you don't have to go looking for it.**"
207209
]
208210
},
209211
{

‎release-scripts/yearly_cleanup.py‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import re
44
import shutil
55
from IPython import get_ipython
6+
import subprocess
67

78
ansi_escape = re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]')
89

@@ -140,6 +141,11 @@ def copy_template(yearly_path, year):
140141
shutil.copy(template_path, destination_file)
141142
print(f"Copied '../internal/templates/yearly-releases.qmd' template to: '{destination_file}'")
142143

144+
try:
145+
subprocess.run(["code", destination_file], check=True)
146+
except Exception as e:
147+
print(f"Error opening the file in VS Code: {e}")
148+
143149
return destination_file
144150

145151
except Exception as e:
@@ -490,7 +496,7 @@ def search_links(yearly_path):
490496
matching_files = 0
491497
total_lines_found = 0
492498

493-
print("Searching for relative links in moved release notes that may need adjusting...\n")
499+
print("Searching for relative links in moved release notes that may need adjusting ...\n")
494500

495501
for root, _, files in os.walk(search_dir):
496502
for file in files:

‎site/guide/model-workflows/_configure-workflow-steps.qmd‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ To add or edit workflow steps:
77

88
1. Click on **Inventory Model**:
99

10-
- To add a step, drag and drop a new step onto the canvas. Hover over the step until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it and select **{{< fa gear >}} Configure**.
11-
- On the new step, click **{{< fa gear >}} Configure**.
10+
- To add a step, drag and drop a new step onto the canvas.
11+
- Double-click the new step to open up the configuration modal.
1212

13-
1. After you're finished with step configuration, click **Save** to apply your changes before closing the configuration panel with **{{< fa x >}}**.
13+
1. After you're finished with step configuration, click **Update Step** to apply your changes before closing the configuration panel with **{{< fa x >}}**.
1414

1515
![Workflow step configuration](/guide/model-workflows/configure-steps.gif){fig-alt="A gif workflow step configuration" .screenshot}
1616

@@ -31,10 +31,10 @@ To add or edit workflow steps:
3131

3232
1. Click on **Inventory Model**:
3333

34-
- To add a step, drag and drop a new step onto the canvas. Hover over the step until the **{{< fa ellipsis-vertical >}}** menu appears, then click on it and select **{{< fa gear >}} Configure**.
35-
- On the new step, click **{{< fa gear >}} Configure**.
34+
- To add a step, drag and drop a new step onto the canvas.
35+
- Double-click the new step to open up the configuration modal.
3636

37-
1. After you're finished with step configuration, click **Save** to apply your changes before closing the configuration panel with **{{< fa x >}}**.
37+
1. After you're finished with step configuration, click **Update Step** to apply your changes before closing the configuration panel with **{{< fa x >}}**.
3838

3939
1. After you've configured a step, you can then link your workflow together.
4040

‎site/guide/model-workflows/_link-workflow-steps.qmd‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@ To initiate the beginning of your workflow:^[After you’ve [configured your wor
77

88
### Link steps together
99

10+
::: {.callout}
11+
Hover over a workflow step to view an animation of the steps connecting to and from that step.
12+
:::
13+
1014
To link subsequent steps together:
1115

1216
1. Click **{{< fa circle >}}** above or below the earlier step and drag it to connect to the top **{{< fa circle >}}** on the subsequent step.
1317

1418
You're also able to link several different steps together at various points in the workflow, including stages that may circle back to previous steps:
1519

16-
![Multiple steps linked together at various points in the default Inventory Model workflow](/guide/model-workflows/linked-workflow.png){fig-alt="A screenshot showing an example of multiple steps linked together at various points in the default Inventory Model workflow" .screenshot}
20+
![Multiple steps linked together at various points in the default Inventory Model workflow](/guide/model-workflows/linked-workflow.gif){fig-alt="An animated gif showing an example of multiple steps linked together at various points in the default Inventory Model workflow" .screenshot}
1721

1822
1. When you are finished, click **Save Workflow** to apply your changes.
1923

@@ -34,7 +38,7 @@ To link subsequent steps together:
3438

3539
You're also able to link several different steps together at various points in the workflow, including stages that may circle back to previous steps:
3640

37-
![Multiple steps linked together at various points in the default Inventory Model workflow](/guide/model-workflows/linked-workflow.png){fig-alt="A screenshot showing an example of multiple steps linked together at various points in the default Inventory Model workflow" .screenshot}
41+
![Multiple steps linked together at various points in the default Inventory Model workflow](/guide/model-workflows/linked-workflow.gif){fig-alt="An animated gif showing an example of multiple steps linked together at various points in the default Inventory Model workflow" .screenshot}
3842

3943
1. When you are finished, click **Save Workflow** to apply your changes.
4044

‎site/guide/model-workflows/_model-workflows-see.qmd‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,14 @@
88
- Click **{{< fa arrow-right-arrow-left >}} See Workflow** to open the detailed workflow associated with that model.
99
- The current workflow state will be highlighted on this detail view.
1010

11-
![Summary view of example workflow steps for a model](/guide/model-workflows/model-workflow.png){width=85% fig-alt="A summary view of example workflow steps for a model" .screenshot}
11+
![Summary view of example workflow steps for a model](/guide/model-workflows/model-workflow.png){fig-alt="A summary view of example workflow steps for a model" .screenshot}
12+
13+
<!-- 2025-jan-07 // There is a bug ATM where this doesn't work: https://app.shortcut.com/validmind/story/7998/viewing-a-model-workflow-doesn-t-have-hover-animations -->
14+
15+
::: {.callout}
16+
Hover over a workflow step to view an animation of the steps connecting to and from that step.
17+
18+
:::
1219

1320
While your lifecycle statuses and workflows are custom to your organization, some examples are:
1421

‎site/guide/model-workflows/approval-group-setup.png‎

-21.9 KB
Loading

‎site/guide/model-workflows/configure-approval-step.png‎

50.3 KB
Loading

‎site/guide/model-workflows/configure-steps.gif‎

746 KB
Loading

0 commit comments

Comments
 (0)