Skip to content

initdb: Add new page for initdb #3833

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Feb 4, 2020
Merged

initdb: Add new page for initdb #3833

merged 4 commits into from
Feb 4, 2020

Conversation

MansoorMajeed
Copy link
Contributor

  • The page (if new), does not already exist in the repo.
  • The page is in the correct platform directory (common/, linux/, etc.)
  • The page has 8 or fewer examples.
  • The PR title conforms to the recommended templates.
  • The page follows the content guidelines.
  • The page description includes a link to documentation or a homepage (if applicable).

@claassistantio
Copy link

claassistantio commented Feb 3, 2020 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

tldr-bot commented Feb 3, 2020

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

pages/common/initdb.md:3: TLDR004 Command descriptions should end in a period
pages/common/initdb.md:5: TLDR005 Example descriptions should end in a colon
pages/common/initdb.md:8: TLDR008 File should contain no trailing whitespace

Please fix the error(s) and push again.

@tldr-bot
Copy link

tldr-bot commented Feb 3, 2020

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

Error: Parse error on line 8:
.../local/var/postgres`:`
-----------------------^
Expecting 'NEWLINE', 'TEXT', 'DASH', 'BACKTICK', got 'COMMAND_TEXT'
pages/common/initdb.md:7: TLDR103 Command example is missing its closing backtick

Please fix the error(s) and push again.

schneiderl
schneiderl requested changes Feb 3, 2020
View reviewed changes
zlatanvasovic
zlatanvasovic suggested changes Feb 3, 2020
View reviewed changes
Copy link
Contributor

@zlatanvasovic zlatanvasovic left a comment

Choose a reason for hiding this comment

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

Are there any other notable examples you'd add here? One may be enough, but the official documentation shows way more.

@zlatanvasovic
initdb: case
246500a 
Co-Authored-By: Zlatan Vasović <[email protected]>
@tldr-bot
Copy link

tldr-bot commented Feb 3, 2020

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

Error: Parse error on line 8:
.../local/var/postgres`:`
-----------------------^
Expecting 'NEWLINE', 'TEXT', 'DASH', 'BACKTICK', got 'COMMAND_TEXT'
pages/common/initdb.md:7: TLDR103 Command example is missing its closing backtick

Please fix the error(s) and push again.

@schneiderl
initdb: Update pages/common/initdb.md
28fca97 
Co-Authored-By: Lucas Gabriel Schneider <[email protected]>
zlatanvasovic
zlatanvasovic approved these changes Feb 3, 2020
View reviewed changes
Copy link
Contributor

@zlatanvasovic zlatanvasovic left a comment

Choose a reason for hiding this comment

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

All good after @schneiderl's suggestions are implemented.

@owenvoke owenvoke added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Feb 3, 2020
@schneiderl schneiderl merged commit 676bb11 into tldr-pages:master Feb 4, 2020
agnivade
agnivade reviewed Feb 22, 2020
View reviewed changes
pages/common/initdb.md
> Create a PostgreSQL database on disk.
> More information: <https://www.postgresql.org/docs/9.5/app-initdb.html>.

- Create a database at /usr/local/var/postgres:
Copy link
Member

Choose a reason for hiding this comment

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

Perhaps we can change it to - "Create a database at a given location." ? I think that is simple enough.

pages/common/initdb.md

- Create a database at /usr/local/var/postgres:

`initdb -D /usr/local/var/postgres`
Copy link
Member

Choose a reason for hiding this comment

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

Please wrap the location within backticks (``)

Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't that be {{token_syntax}}, @agnivade?

Copy link
Member

Choose a reason for hiding this comment

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

My bad. Yes it should be the token syntax

Copy link
Member

@sbrl sbrl Feb 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Suggested change
`initdb -D /usr/local/var/postgres`
`initdb -D {{/usr/local/var/postgres}}`

(also, is there a long form of that flag?)

@dmmqz dmmqz mentioned this pull request Sep 7, 2025
Closed
35 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@agnivade agnivade agnivade left review comments

@sbrl sbrl sbrl left review comments

@schneiderl schneiderl schneiderl approved these changes

+1 more reviewer

@zlatanvasovic zlatanvasovic zlatanvasovic approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@MansoorMajeed @claassistantio @tldr-bot @agnivade @zlatanvasovic @sbrl @schneiderl @owenvoke