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

couchdb: add page #1553

Merged
merged 4 commits into from
Oct 20, 2017
Merged

couchdb: add page #1553

merged 4 commits into from
Oct 20, 2017

Conversation

lamar-frankie
Copy link
Contributor

@lamar-frankie lamar-frankie commented Oct 18, 2017


  • [ x] The page (if new), does not already exist in the repo.

  • [x ] The page (if new), has been added to the correct platform folder:
    common/ if it's common to all platforms, linux/ if it's Linux-specific, and so on.

  • [ x] The page has 8 or fewer examples.

  • [ x] The PR is appropriately titled:
    <command name>: add page for new pages, or <command name>: <description of changes> for pages being edited

  • [ x] The page follows the contributing guidelines

Closes #1175

@tldr-bot
Copy link

The build for this PR has failed with the following error(s):

pages/common/couchdb.md:36: TLDR008 File should contain no trailing whitespace

Please fix the error(s) and push again.

@agnivade
Copy link
Member

Some general comments before we dive in further.

  • Start with the simplest invocation first. Just couchdb.
  • The page seems too long. We should trim it down a bit, maybe up to 6 examples would be good.
  • There should be a natural flow to the examples. Regarding the killing of background process, start with the -b option, which spawns a background process, then move on to -k which kills it, and then -d, which shuts it down.

In general, think about which options are not necessary, and which options are required for a beginner to get started. Accordingly update the page.

@agnivade agnivade added the new command Issues requesting creation of a new page. label Oct 19, 2017
@lamar-frankie
Copy link
Contributor Author

I simplified the page. I think all the commands that remain are pertinent.
Start couchdb
Launch shell
Start in the background
Kill
Shutdown

@agnivade
Copy link
Member

@lamar-frankie - made a minor change. Let me know if this looks good to you.

@sbrl sbrl merged commit 65163f0 into tldr-pages:master Oct 20, 2017
@sbrl
Copy link
Member

sbrl commented Oct 20, 2017

Looks good to me! Thanks, @lamar-frankie 😺

@lamar-frankie lamar-frankie deleted the page-couchdb branch December 18, 2017 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants