Skip to content

Commit 5ee4274

Browse files
authored
docs: Restore usecases/README "Preview Deployment" (#247)
* docs: Restore usecases/README "Preview Deployment" * docs: warn user of outdated image * docs: clarity
1 parent 5c76d25 commit 5ee4274

1 file changed

Lines changed: 18 additions & 19 deletions

File tree

user-guide/usecases/README.md

Lines changed: 18 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -171,24 +171,6 @@ You can [**test your changes** on your local machine](../../../README.md#testing
171171
> - Use 4 spaces to indent.
172172
> - Add a new line before starting a list.
173173
174-
<details><summary>Preview Deployment — ⚠️ Feature Not Available Yet</summary>
175-
176-
> **Note**: This valuable automated feature was in [DS_Use_Case_template](https://github.com/DesignSafe-CI/DS_Use_Case_template/blob/c32d48a/README.md?plain=1#L76-L80). It will eventually be added here also.
177-
178-
After a minute or so a preview deployment of your use case will be available on the pull request page. Select the preview link generated by Netlify to view your changes similar to how it would be rendered in the final version. If you want to make some tweaks. If you created a fork repo, visit that fork repo to make changes. As long as the current PR remains open GitHub will automatically pull your changes.
179-
180-
| link to preview of deployment |
181-
| - |
182-
| ⚠️ Feature unavailable. Until feature is available, you may view an [outdated image](docs/images/21-pr.png). |
183-
<!-- ![PR](docs/images/21-pr.png) | -->
184-
185-
| preview of deployment |
186-
| - |
187-
| ⚠️ Feature unavailable. Until feature is available, you may view an [outdated image](docs/images/22-preview.png). |
188-
<!-- ![preview Web](docs/images/22-preview.png) | -->
189-
190-
</details>
191-
192174
### <a id="add-to-guide"></a> 12. Add New Use Case to User Guide
193175

194176
If you have added a Use Case, add it to the [`nav` in `user-guide/mkdocs.yml`](https://github.com/DesignSafe-CI/DS-User-Guide/blob/v2.8.0/user-guide/mkdocs.yml#L116-L142)
@@ -242,5 +224,22 @@ To add the new use case to "Wind & Storm Surge":
242224

243225
<sup>Edit the new line to point to the new use case.</sup>
244226

227+
### <a id="preview-deploy"></a> 13. Preview Deployment
228+
229+
After a minute or so a preview deployment of your use case will be available on the pull request page. Select the preview link generated by Netlify to view your changes similar to how it would be rendered in the final version. If you want to make some tweaks. If you created a fork repo, visit that fork repo to make changes. As long as the current PR remains open GitHub will automatically pull your changes.
230+
231+
> [!WARNING]
232+
> Image is outdated. But feature is working as of 2025-12-09.
233+
234+
| link to preview of deployment |
235+
| - |
236+
| ![PR](docs/images/21-pr.png) |
237+
238+
> [!WARNING]
239+
> Image is outdated. But feature is working as of 2025-12-09.
240+
241+
| preview of deployment |
242+
| - |
243+
| ![preview Web](docs/images/22-preview.png) |
244+
245245
[DS-User-Guide]: https://github.com/DesignSafe-CI/DS-User-Guide/
246-
[DS_Use_Case_template]: https://github.com/DesignSafe-CI/DS_Use_Case_template/

0 commit comments

Comments
 (0)