Skip to content
This repository has been archived by the owner on Aug 3, 2023. It is now read-only.

Re-order kv commands docs to be more user friendly #558

Merged
merged 8 commits into from
Sep 12, 2019

Conversation

EverlastingBugstopper
Copy link
Contributor

Fixes #553

Copy link
Contributor

@gabbifish gabbifish left a comment

Choose a reason for hiding this comment

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

I think the re-ordering of the subcommands is great, but still very, very strongly believe the documentation about --binding/--namespace-id and --env should live at the top of this document; otherwise, this very important information gets buried in subcommands.

docs/content/kv_commands.md Show resolved Hide resolved
docs/content/kv_commands.md Show resolved Hide resolved
@EverlastingBugstopper
Copy link
Contributor Author

My general thought is that it's confusing to users when you explain high level concepts before they're ready for them - you don't understand bindings and namespace ids when you have yet to create a namespace in the first place. I agree that this might get buried and cmd+f to a single spot might be difficult. Perhaps we should make a heading called "Getting Started" which just has you create a namespace, and then jump into concepts w/ environments and namespace id/binding explanation, followed by the rest of the doc.

@gabbifish
Copy link
Contributor

I like your Getting Started idea! Let's see what Dubs thinks and we can move forward from there :D

@EverlastingBugstopper
Copy link
Contributor Author

This looks great!

docs/content/kv_commands.md Outdated Show resolved Hide resolved
docs/content/kv_commands.md Outdated Show resolved Hide resolved
@gabbifish gabbifish merged commit a8926e7 into feat-kv-commands Sep 12, 2019
@delete-merged-branch delete-merged-branch bot deleted the avery/kv-commands-docs branch September 12, 2019 18:39
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants