Add test track doc (#549)

exercism · Aug 2, 2024 · 60eb604 · 60eb604
1 parent 3246766
commit 60eb604
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/building/config.json b/building/config.json
@@ -230,6 +230,12 @@
     "path": "building/tracks/new/prepare-for-launch.md",
     "title": "Prepare for launch"
   },
+  {
+    "uuid": "3d4a4f07-7229-4910-9ba5-b7d931ff9177",
+    "slug": "tracks/new/test-track",
+    "path": "building/tracks/new/test-track.md",
+    "title": "Test track"
+  },
   {
     "uuid": "296dbe06-3384-409b-b2de-be52593c76d3",
     "slug": "tracks/new/find-maintainers",

diff --git a/building/tracks/new/README.md b/building/tracks/new/README.md
@@ -15,6 +15,7 @@ Once you've completed that step, the next steps are:
 - [Build test runner](/docs/building/tracks/new/build-test-runner)
 - [Configure tooling](/docs/building/tracks/new/configure-tooling)
 - [Prepare for launch](/docs/building/tracks/new/prepare-for-launch)
+- [Test track](/docs/building/tracks/new/test-track)
 - [Find Maintainers](/docs/building/tracks/new/find-maintainers)
 - [Launch!](/docs/building/tracks/new/launch)
 - [Enable syntax highlighting](/docs/building/tracks/new/syntax-highlighting)

diff --git a/building/tracks/new/test-track.md b/building/tracks/new/test-track.md
@@ -0,0 +1,20 @@
+# Test track
+
+_Before_ launching your track (meaning, the `"active"` key is still `false` in the track's `config.json`), it is important the track is tested.
+This will help find (common) errors and allows them to be fixed _before_ the track is launched, which means that students won't ever encounter them.
+
+## How to enable the track for testing
+
+To enable the track for testing, it needs to be added to our database, which is something only site admins can do.
+Please open a topic on the forum requesting this at: https://forum.exercism.org/c/exercism/building-exercism/125.
+
+Note that adding the track to the database will _not_ launch the track, but it _will_ make it accessible on the website for maintainer users.
+
+## How to find testers
+
+The ideal users to test the track are other track maintainers, as they:
+
+- Have experience building a track (and thus know what should have been built)
+- Are able to access track's that are not yet active
+
+To get maintainers to test your track, open a topic on the forum requesting this at: https://forum.exercism.org/c/exercism/building-exercism/125.