Skip to content
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

hint to "deploy help" in the documentation #1108

Merged
merged 5 commits into from
Mar 22, 2024
Merged

Conversation

Fil
Copy link
Contributor

@Fil Fil commented Mar 19, 2024

closes #1105

@Fil Fil requested review from mbostock and mythmon March 19, 2024 16:10
Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate the additional documentation, but this feels a little out of place here. I think it would be better to expand the observable help deploy output as I mentioned in Slack (which already cover these options, but could be expanded and cover the other arguments and commands, too; and we could have nicer formatting that wraps). We could also have a command reference page, perhaps, though I like the idea that the reference is built-in to the tool itself.

@Fil
Copy link
Contributor Author

Fil commented Mar 19, 2024

Then maybe we just say "call npm observable help deploy for more options"?

@mbostock
Copy link
Member

It’s npm run observable help deploy, but yeah. 😅

@Fil Fil enabled auto-merge (squash) March 19, 2024 19:42
@Fil Fil changed the title add documentation for --message, --if-stale, --if-missing hint to "deploy help" in the documentation Mar 19, 2024
Copy link
Member

@mbostock mbostock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made it a tip, and switched to:

npm run deploy -- --help

@Fil Fil merged commit 1f426a3 into main Mar 22, 2024
4 checks passed
@Fil Fil deleted the fil/document-deploy-options branch March 22, 2024 00:41
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.

document --if-missing and --if-stale
2 participants