Intent to Archive & Redirect

[wesleyboar]

My Understanding

2023 & Before

This DesignSafe-CI/DS_Use_Case_template repository was both instruction (via its README) to add a Use Case doc and a way for public to add a Use Case doc. And it was previewed at ds-use-case-preview.netlify.app and public at www.designsafe-ci.org/ds-use-case/

2023 & After

DS docs for Use Cases is now in (private) DesignSafe-CI/DS-User-Guide:/user-guide/docs/usecases and served at (public) www.designsafe-ci.org/user-guide/.

My Proposal

Replace this DesignSafe-CI/DS_Use_Case_template repo with (private) DesignSafe-CI/DS-User-Guide:/user-guide/docs/usecases made public.

Tasks

• Redirect /ds-use-case/ URL to /user-guide/usecases/.
• Move and adapt instructions to DS-User-Guide.
• Open DS-User-Guide to the public.
• 🆕 Redirect DS_Use_Case_template visitors to DS-User-Guide.
• Archive DS_Use_Case_template.
  _{docs(README): gh-53 redirect users to new code location #56}
• Replicate or Retire ds-use-case-preview.netlify.app.
  _{Can Not Migrate Netlify-Based Auto-Preview DS-User-Guide#61}

[kks32]

@wesleyboar This sounds good to me. I created the netlify app, so let me know when you like to disable or redirect it.

[wesleyboar]

@wesleyboar, you track this task via DES-2668.

[wesleyboar]

@kks32 Will do, thanks.

[wesleyboar]

@kks32,

1. I migrate the README via DesignSafe-CI/DS-User-Guide#12 [outdated inaccurate link]. I will request you have access, so you may review and contribute.
2. I read step 11, "After a minute or so a preview deployment of your use case will be available on the pull request page." That's great — a preview per branch auto-deployed! I would love your help to replicate this for https://github.com/DesignSafe-CI/DS-User-Guide/. Are you available to collaborate?

[wesleyboar]

Oh, also, I've found some direction on #8 by @rstijerina. I'll see how far that takes me.

[wesleyboar]

Status

• …
• Move and adapt instructions to DS-User-Guide
  _{My first pass in updating use-case documentation DS-User-Guide#12
  The DS-User-Guide has "Contributing" section README.}
• Open DS-User-Guide to the public.
• …
• Replicate or retire ds-use-case-preview.netlify.app.
  • Add build workflow for Netlify to use (DesignSafe-CI/DS-User-Guide@b9a70a5).
  • Ask @kks32 to update his Netlify app config to use DS-User-Guide build.
  • …

[wesleyboar]

A while back I redirected /ds-use-case/ to /user-guide/usecases/.

I plan to point visitors from this repo to the new one.

And the Netlify thing must be replicated…

• I started in .github/workflows/build-preview.yml.
• I added "Local Testing" steps in REAMDE, but contributors are not testing.

[wesleyboar]

Status

1. docs(README): gh-53 redirect users to new code location #56
2. Can Not Migrate Netlify-Based Auto-Preview DS-User-Guide#61

[wesleyboar]

@kks32, you may retire/archive this repository, because DS-User-Guide has automatic preview deploys via Netlify, since v3 (released today).

^{@wesleyboar, when repo is archived, update CMD-204.}