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

[INLONG-4758][Doc] Remove leading $ sign in README.md #4759

Merged
merged 1 commit into from
Jun 24, 2022

Conversation

boatrainlsz
Copy link
Contributor

@boatrainlsz boatrainlsz commented Jun 23, 2022

Motivation

In convenience of coping and pasting for users, command line codes in READEME should remove leading $ sign. take kafka for example, there is no leading $ sign before the codes in kafka READEME.md

Modifications

Removed leading $ sign in README.md

Verifying this change

(Please pick either of the following options)

  • This change is a trivial rework/code cleanup without any test coverage.

  • This change is already covered by existing tests, such as:
    (please describe tests)

  • This change added tests and can be verified as follows:

    (example:)

    • Added integration tests for end-to-end deployment with large payloads (10MB)
    • Extended integration test for recovery after broker failure

Documentation

  • Does this pull request introduce a new feature? (yes / no)
  • If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
  • If a feature is not applicable for documentation, explain why?
  • If a feature is not documented yet in this PR, please create a follow-up issue for adding the documentation

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thanks a lot for your contribution! 💖 This seems to be your first PR! 🌠 Please be sure to follow our contribution guidelines! 🎁

@boatrainlsz boatrainlsz reopened this Jun 24, 2022
Copy link
Member

@healchow healchow left a comment

Choose a reason for hiding this comment

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

LGTM

@dockerzhang
Copy link
Contributor

@boatrainlsz thanks.
1, do not need open and close PR when you update the commit.
2, "$" means normal users can execute this command. we can merge it for a convenient ‘copy’.

@dockerzhang dockerzhang merged commit d60af2b into apache:master Jun 24, 2022
@boatrainlsz
Copy link
Contributor Author

@boatrainlsz thanks. 1, do not need open and close PR when you update the commit. 2, "$" means normal users can execute this command. we can merge it for a convenient ‘copy’.

thanks for your advice

vernedeng pushed a commit to vernedeng/incubator-inlong that referenced this pull request Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Improve][Doc] Command-line codes in README should remove the leading $ sign
4 participants