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

New --help command docs #1527

Merged
merged 6 commits into from
Nov 18, 2020
Merged

New --help command docs #1527

merged 6 commits into from
Nov 18, 2020

Conversation

JackuB
Copy link
Contributor

@JackuB JackuB commented Nov 17, 2020 •
edited
Loading

This PR reworks --help command content:

  • help is now in markdown instead of .txt
  • each command has a special help page
  • man pages are generated from the markdown

Docker container with ronn-ng is added to format markdown help files into a .roff format used for man pages.

See readme file in help/readme.md
https://github.com/snyk/snyk/pull/1527/files#diff-7b4c756c0f1a775bd64a89e1a3c82d530b7e0fb6d45930fbf926d17c050ed958

Follow up to #1525

Screenshot 2020-11-17 at 14 45 07

@JackuB JackuB requested a review from a team November 17, 2020 13:44
@JackuB JackuB requested a review from a team as a code owner November 17, 2020 13:44
@JackuB JackuB requested a review from a team November 17, 2020 13:44
@ghost ghost requested review from gitphill and razzmadaz November 17, 2020 13:44
@github-actions
Copy link
Contributor

github-actions bot commented Nov 17, 2020 •
edited
Loading

Messages
📖 You are modifying something in test/smoke directory, yet you are not on the branch starting with smoke/. You can prefix your branch with smoke/ and Smoke tests will trigger for this PR.

Generated by 🚫 dangerJS against 789af6b

gitphill
gitphill approved these changes Nov 17, 2020
View reviewed changes
Copy link
Contributor

@gitphill gitphill left a comment

Choose a reason for hiding this comment

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

very nice 👍

@JackuB JackuB force-pushed the feat/command-docs branch 2 times, most recently from ca93fe6 to ea4c894 Compare November 17, 2020 14:18
rontalx
rontalx reviewed Nov 17, 2020
View reviewed changes
Copy link
Contributor

@rontalx rontalx left a comment

Choose a reason for hiding this comment

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

can you please add cloud config as code owners to the following files:
help/commands-docs/iac-examples.md
help/commands-docs/iac.md

pavel-snyk
pavel-snyk approved these changes Nov 17, 2020
View reviewed changes
Copy link
Contributor

@pavel-snyk pavel-snyk left a comment

Choose a reason for hiding this comment

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

LGTM!

garethr
garethr reviewed Nov 17, 2020
View reviewed changes
Copy link
Contributor

@garethr garethr left a comment

Choose a reason for hiding this comment

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

Love this. A few picky comments left.

help/commands-docs/_EXAMPLES.md Outdated Show resolved Hide resolved
help/commands-docs/_ENVIRONMENT.md Show resolved Hide resolved
help/commands-docs/_SNYK_COMMAND_HEADER.md Outdated Show resolved Hide resolved
help/commands-docs/_SNYK_COMMAND_HEADER.md Show resolved Hide resolved
help/commands-docs/_SNYK_COMMAND_OPTIONS.md Outdated Show resolved Hide resolved
help/commands-docs/container.md Outdated Show resolved Hide resolved
@JackuB
Copy link
Contributor Author

JackuB commented Nov 17, 2020

@rontalx added you to the codeowners 👍

Thanks a lot @garethr! Updated the docs

@github-actions
Copy link
Contributor

github-actions bot commented Nov 17, 2020 •
edited by JackuB
Loading

Expected release notes (by @JackuB)

features:
new —help documentation (69a8327)

others (will not be included in Semantic-Release notes):
fix ukraine language code in woof command (789af6b)
update --help docs (47358cd)
update —help tests (401265d)
introduce help documentation generator (d08bc49)
remove old help files (ea25583)

  • I hereby acknowledge these release notes are 🥙 AWESOME 🥙

rontalx
rontalx approved these changes Nov 17, 2020
View reviewed changes
Copy link
Contributor

@rontalx rontalx left a comment

Choose a reason for hiding this comment

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

:shipit: 🚀

@JackuB JackuB merged commit 3e22db5 into master Nov 18, 2020
@JackuB JackuB deleted the feat/command-docs branch November 18, 2020 09:21
@JackuB JackuB mentioned this pull request Nov 18, 2020
Merged
3 tasks
@snyksec
Copy link

snyksec commented Nov 18, 2020

🎉 This PR is included in version 1.428.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@garethr garethr garethr left review comments

@gitphill gitphill gitphill approved these changes

@rontalx rontalx rontalx approved these changes

@pavel-snyk pavel-snyk pavel-snyk approved these changes

@razzmadaz razzmadaz Awaiting requested review from razzmadaz

Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@JackuB @snyksec @garethr @gitphill @rontalx @pavel-snyk