Changes in documentation #1084
Merged
Changes in documentation #1084
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kasia-kujawa
requested review from
sumo-drosiek,
perk-sumo,
pmalek-sumo and
andrzej-stencel
pmalek-sumo
reviewed
Nov 12, 2020
vagrant/README.md
Outdated
Comment on lines
39
to
41
| ```bash | ||
| /sumologic/vagrant/Makefile build | ||
| sumo-make build | ||
| ``` |
There was a problem hiding this comment.
keep the old one as alternative as well ... or ... (2 snippets)
vagrant/README.md
Outdated
Comment on lines
47
to
49
| ```bash | ||
| /sumologic/vagrant/Makefile upgrade | ||
| sumo-make upgrade | ||
| ``` |
vagrant/README.md
Outdated
Comment on lines
56
to
58
| ```bash | ||
| /sumologic/vagrant/Makefile clean | ||
| sumo-make clean | ||
| ``` |
vagrant/README.md
Outdated
|
|
||
| ## Test | ||
|
|
||
| To quickly test whether sumo-kubernetes-collection works receiver-mock can be used. |
There was a problem hiding this comment.
Suggested change
| To quickly test whether sumo-kubernetes-collection works receiver-mock can be used. | |
| In order to quickly test whether sumo-kubernetes-collection works, one can use `receiver-mock` for that purpose. |
🤷🏻
vagrant/README.md
Outdated
Comment on lines
70
to
77
| To check receiver-mock logs please use: | ||
| ``` | ||
| kubectl logs $(kubectl get pod -l app=receiver-mock -o jsonpath="{.items[0].metadata.name}" -n receiver-mock) -n receiver-mock | ||
| ``` | ||
| To check metrics exposed by receiver-mock please use: | ||
| ``` | ||
| kubectl exec $(kubectl get pod -l app=receiver-mock -o jsonpath="{.items[0].metadata.name}" -n receiver-mock) -it -n receiver-mock -- curl http://localhost:3000/metrics | ||
| ``` |
There was a problem hiding this comment.
Empty lines around snippet backticks
pmalek-sumo
reviewed
Nov 12, 2020
vagrant/README.md
Outdated
Comment on lines
69
to
70
| sumo-make clean | ||
|
|
There was a problem hiding this comment.
Suggested change
| sumo-make clean | |
| sumo-make clean |
kasia-kujawa
force-pushed
the
kkujawa-fix-docs
branch
from
d10afb5
to
17e80dd
Compare
pmalek-sumo
reviewed
Nov 12, 2020
vagrant/README.md
Outdated
| @@ -30,18 +30,32 @@ After successfull installation you can ssh to the virtual machine with: | |||
| vagrant ssh | |||
| ``` | |||
|
|
|||
| NOTICE: The directory with sumo-kubernetes-collection repository is synced with the virtual machine. | |||
There was a problem hiding this comment.
Suggested change
| NOTICE: The directory with sumo-kubernetes-collection repository is synced with the virtual machine. | |
| NOTICE: The directory with sumo-kubernetes-collection repository on the host is synced with `/sumologic/` directory on the virtual machine. |
|
@pmalek-sumo please take another look |
|
|
||
| ``` | ||
| kubectl exec $(kubectl get pod -l app=receiver-mock -o jsonpath="{.items[0].metadata.name}" -n receiver-mock) -it -n receiver-mock -- curl http://localhost:3000/metrics | ||
| ``` |
There was a problem hiding this comment.
We could add those commands as new targets to the Makefile. Not necessary in this PR :)
There was a problem hiding this comment.
We could add those commands as new targets to the
Makefile. Not necessary in this PR :)
I'll add this in a new PR
pmalek-sumo
approved these changes
Nov 12, 2020
sumo-drosiek
approved these changes
Nov 12, 2020
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Testing performed