Updating Beginner Documentation #105
Merged
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
bossenti
approved these changes
Sep 8, 2023
|
thanks a lot for these improvements @lab596 🙏🏼 |
bossenti
reviewed
Sep 8, 2023
README.md
Outdated
| @@ -9,11 +9,11 @@ Two different technologies are used to create both sites: | |||
|
|
|||
| Both parts are merged to a single directory during the CI process. | |||
|
|
|||
| Node.js and npm are required to build the documentation. | |||
| Node.js(v14 - v16) and npm are required to build the documentation. | |||
There was a problem hiding this comment.
Why do you think we are only compatible to Node v14 to 16?
Our PR validation and deployment both run in Node version 18
bossenti
pushed a commit
that referenced
this pull request
Sep 9, 2023
* updating beginner documentation * Update README.md
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.
Purpose
Hey, the purpose of these changes is to add additional documentation to assist newcomers more easily in launching and interacting with streampipes in the terminal interface. As someone who recently cloned the project, I noticed a few errors as well as key information that could be added to the documentation for easier implementation.
Note
I was struggling to update the local build, so I was unable to view my local changes. Please let me know if I have edited the files correctly and if this pull request will update the website. Additionally, I believe that this pull request does not update the README.md on the main repo. Please let me know if I should create a pull request there to reflect these changes.