Document lockedEditor=1 flag for tutorials (microsoft#7439)

shakao · ganicke · web-flow · commit fe905f7ed366 · 2020-09-03T08:07:48.000-07:00
* Document lockedEditor=1 flag for tutorials

* Use Arcade example, add note about rollout

* a few marks

Co-authored-by: Galen Nickel &lt;v-gani@microsoft.com&gt;
diff --git a/docs/writing-docs/tutorials.md b/docs/writing-docs/tutorials.md
@@ -388,6 +388,14 @@ basic.showString("Hello!")
 
 Users will have the option of clicking the Python icon to see the snippet in Python just like they can with Blocks and Javascript/Typescript.
 
+## Editor flags
+
+There are some flags you can add to the URL of your tutorial to change the layout of the page. These are not yet enabled for every editor, so make sure you check that the feature is available in your target.
+
+* **lockedEditor=1** - If you load the page directly into a tutorial, adding the `lockedEditor` flag will "lock" users into the tutorial. This hides the "Exit Tutorial", "Home", and "Finish" buttons, as well as disabling the right-click menu outside of the Blocks workspace to prevent users from entering the home screen or sandbox mode. For example:
+
+    https://arcade.makecode.com?lockedEditor=1#tutorial:/tutorials/happy-flower
+
 ## Adding tutorials to the home screen
 
 To have a tutorial appear on the home screen, you will need to create or use an existing gallery and add a tutorial entry to it. See the
@@ -453,4 +461,4 @@ Tutorials are translated via [Crowdin](/translate) like any other documentation
 
 ## Dependencies
 
-If your tutorial requires the use of an extension, you can add them using the [package macro](https://makecode.com/writing-docs/macros#dependencies).
+If your tutorial requires the use of an extension, you can add them using the [package macro](https://makecode.com/writing-docs/macros#dependencies).
