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.

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

"cdk docs" platform-specific browser command #2847

Closed
dhx-mike-palandra opened this issue Jun 12, 2019 · 2 comments · Fixed by #9549
Closed

"cdk docs" platform-specific browser command #2847

dhx-mike-palandra opened this issue Jun 12, 2019 · 2 comments · Fixed by #9549
Assignees
@shivlaks
Labels
bug This issue is a bug. good first issue Related to contributions. See CONTRIBUTING.md p2 package/tools Related to AWS CDK Tools or CLI

Comments

@dhx-mike-palandra
Copy link

$ cdk --version
0.34.0 (build 523807c)

The docs command should set --browser to a sensible value based on host platform.

On my platform of choice (cpe:/o:fedoraproject:fedora:30), the current default does not open a web browser. A more reasonable default for me and probably for other Linux users would be xdg-open %u.
@dhx-mike-palandra dhx-mike-palandra added the feature-request A feature should be added or improved. label Jun 12, 2019
@NGL321 NGL321 added the needs-triage This issue or PR still needs to be triaged. label Jun 17, 2019
@shivlaks shivlaks added package/tools Related to AWS CDK Tools or CLI good first issue Related to contributions. See CONTRIBUTING.md and removed needs-triage This issue or PR still needs to be triaged. labels Aug 27, 2019
@shivlaks
Copy link
Contributor

hey @dhx-mike-palandra

Do all Linux users run into this behaviour right now?I agree it would be beneficial to have reasonable defaults for other platforms.

Perhaps the browser could just be configurable as a user setting through ~/.cdk.json

@shivlaks shivlaks added bug This issue is a bug. and removed feature-request A feature should be added or improved. labels Aug 27, 2019
@shivlaks shivlaks added the p2 label Oct 31, 2019
@shivlaks shivlaks mentioned this issue Jan 15, 2020
Closed
@shivlaks
Copy link
Contributor

shivlaks commented Aug 7, 2020

closed by #5800

@shivlaks shivlaks closed this as completed Aug 7, 2020
@gmeligio gmeligio mentioned this issue Aug 21, 2020
Merged
mergify bot pushed a commit that referenced this issue Sep 1, 2020
@gmeligio
fix(cli): Linux browser not supported for cdk docs (#9549)
663913f 
fix(cli): Add browser command for Linux

Adding "xdg-open %u" that is available in all free-desktop distros, so it can be used as the standard docs command for Linux users

Fixes #2847

----

* By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shivlaks shivlaks

Labels
bug This issue is a bug. good first issue Related to contributions. See CONTRIBUTING.md p2 package/tools Related to AWS CDK Tools or CLI
Projects
None yet
Milestone
No milestone
3 participants
@NGL321 @shivlaks @dhx-mike-palandra