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

asterisk: add page #4474

Merged
merged 7 commits into from
Oct 15, 2020
Merged

asterisk: add page #4474

merged 7 commits into from
Oct 15, 2020

Conversation

girlpunk
Copy link
Contributor

@girlpunk girlpunk commented Oct 4, 2020

  • 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).

One of the pages requested in #3689. I've focused on commands used for managing a running server with SIP clients on chan_sip as these are used most frequently.

@CLAassistant
Copy link

CLAassistant commented Oct 4, 2020

CLA assistant check
All committers have signed the CLA.

@tldr-bot
Copy link

tldr-bot commented Oct 4, 2020

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

pages/linux/asterisk.md:15: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/asterisk.md:19: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/asterisk.md:23: TLDR005 Example descriptions should end in a colon with no trailing characters
pages/linux/asterisk.md:27: TLDR005 Example descriptions should end in a colon with no trailing characters

Please fix the error(s) and push again.

@navarroaxel navarroaxel changed the title asterisk: Add page asterisk: add page Oct 4, 2020
@navarroaxel navarroaxel added the new command Issues requesting creation of a new page. label Oct 4, 2020
pages/linux/asterisk.md Outdated Show resolved Hide resolved

- Show chan_SIP clients (phones):

`asterisk -r -x "sip show peers"`
Copy link
Member

Choose a reason for hiding this comment

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

Are there any long forms of these arguments? We generally prefer long forms on tldr pages to aid clarity.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately not. I can see some other tldr pages uses syntax such as [r]econnect, would this work for an extra example such as this?

- [r]econnect to a running server and e[x]ecute a command:

`asterisk -r -x "{{command}"`

Copy link
Member

Choose a reason for hiding this comment

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

No problem - it doesn't hurt to check. Yeah, that extra example would be great if possible!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How's that looking now?

Copy link
Member

Choose a reason for hiding this comment

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

Much better, thanks :D

I've just left a comment about a potential typo.

girlpunk and others added 2 commits October 6, 2020 18:29
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
pages/linux/asterisk.md Outdated Show resolved Hide resolved
Co-authored-by: Starbeamrainbowlabs <sbrl@starbeamrainbowlabs.com>
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

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

Thanks, @cyberjacob ❤️


- Show chan_SIP clients (phones):

`asterisk -r -x "sip show peers"`
Copy link
Member

Choose a reason for hiding this comment

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

Much better, thanks :D

I've just left a comment about a potential typo.

@sbrl
Copy link
Member

sbrl commented Oct 14, 2020

Looks like this one slipped through the net. /cc @owenvoke / @navarroaxel / @agnivade for a 2nd opinion?

Copy link
Member

@navarroaxel navarroaxel left a comment

Choose a reason for hiding this comment

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

@cyberjacob just 2 comments

pages/linux/asterisk.md Outdated Show resolved Hide resolved
pages/linux/asterisk.md Outdated Show resolved Hide resolved
girlpunk and others added 2 commits October 15, 2020 21:22
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
@navarroaxel navarroaxel merged commit d9e540a into tldr-pages:master Oct 15, 2020
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.

5 participants