Skip to content

docs: Rewrite the "Get started" tutorial#206

Draft
NickVolynkin wants to merge 3 commits into
canonical:mainfrom
NickVolynkin:nickvolynkin-tutorial-fixup
Draft

docs: Rewrite the "Get started" tutorial#206
NickVolynkin wants to merge 3 commits into
canonical:mainfrom
NickVolynkin:nickvolynkin-tutorial-fixup

Conversation

@NickVolynkin

@NickVolynkin NickVolynkin commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

Rewrite the tutorial according to the following principles:

  • Define the goal and value of a tutorial clearly.
  • Don't make value judgments such as "simple" or "complex". Present the facts so that the user can form their own judgment.
  • Provide users with a single straightforward way to complete the tutorial. (When users see options in a tutorial, they have to stop and make decisions, which reduces the tutorial completion rate.)
  • Provide supplementary information and 'further reading' links after actions, not before.

Preview: https://canonical-openstack--206.com.readthedocs.build/en/206/tutorial/get-started-with-openstack/

Rewrite the tutorial according to the following principles:

- Define the goal and value of a tutorial clearly.
- Don't make value judgements such as "simple" or "complex".
  Present the facts so that the user can form their own judgement.
- Provide users with a single straightforward way to complete the tutorial.
  (When users see options in a tutorial, they have to stop and make decisions,
  which reduces the tutorial completion rate).
- Provide supplementary information and 'further reading' links after actions,
  not before.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
NickVolynkin force-pushed the nickvolynkin-tutorial-fixup branch from 55f1e99 to 0afd1db Compare June 5, 2026 07:09
Temporary commit, to be squashed.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
NickVolynkin force-pushed the nickvolynkin-tutorial-fixup branch 2 times, most recently from 78c7cb8 to 4788343 Compare June 10, 2026 10:10
Temporary commit, to be squashed.

Signed-off-by: Nick Volynkin <nick.volynkin@gmail.com>
@NickVolynkin
NickVolynkin force-pushed the nickvolynkin-tutorial-fixup branch from 4788343 to 77c4daa Compare June 10, 2026 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant