Skip to content

shorter getting started #1245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2024
Merged

shorter getting started #1245

merged 3 commits into from
Apr 16, 2024

Conversation

mbostock
Copy link
Member

@mbostock mbostock commented Apr 16, 2024

As we heard from @CAYdenberg in #1187 (comment), the Getting started tutorial is currently a bit tedious in that it walks you through what are already very clear prompts in the terminal. This truncates the walk-through to provide only a bit of context (e.g., “accept the default values”) and the output on success (for confirmation).

I’ve also added a small intro message to the create command so that there’s a little more context when you run npm init @observablehq, including a link back to the Getting started tutorial:

┌   observable create  v1.5.1
│
◆  Welcome to Observable Framework! 👋 This command will help you create a new
│  project. When prompted, you can press Enter to accept the default value.
│
│  Want help? https://observablehq.com/framework/getting-started
│
◆  Where should we create your project?
│  ./hello-framework
└

I changed the “Problems?” link to point to our discussions rather than the tutorial (since chances are you are already following the tutorial, and the tutorial won’t be much help if the command didn’t work, anyway).

I tweaked the first two prompts:

  • “Where to create your project?” is now “Where should we create your project?”
  • “What to title your project?” is now “What should we title your project?”

I changed the default path to be ./hello-framework to hint that it can be a relative path and not just a simple name in the current directory. This reverts #1135 but shows the correct path on Windows, which should address the point raised in #1134.

I also changed the convert, deploy, and login commands to display the Framework version number, matching the create command.

@mbostock mbostock requested a review from Fil April 16, 2024 00:56
@mbostock mbostock enabled auto-merge (squash) April 16, 2024 00:56
@mbostock mbostock mentioned this pull request Apr 16, 2024
@mbostock mbostock merged commit d751c03 into main Apr 16, 2024
4 checks passed
@mbostock mbostock deleted the mbostock/shorter-getting-started branch April 16, 2024 06:12
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.

2 participants