You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@streampipes.apache.org by "lab596 (via GitHub)" <gi...@apache.org> on 2023/09/07 18:55:58 UTC
[GitHub] [streampipes-website] lab596 opened a new pull request, #105: Updating Beginner Documentation
lab596 opened a new pull request, #105:
URL: https://github.com/apache/streampipes-website/pull/105
<!--
Thanks for contributing! Here are some tips you can follow to help us incorporate your contribution quickly and easily:
1. If this is your first time, please read our contributor guidelines:
- https://streampipes.apache.org/getinvolved.html
- https://cwiki.apache.org/confluence/display/STREAMPIPES/Getting+Started
2. Make sure the PR title is formatted like: `[<# GitHub issue id>] PR title ...`
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., `[WIP][<# GitHub issue id>] PR title ...`.
4. Please write your PR title to summarize what this PR proposes/fixes.
5. Be sure to keep the PR description updated to reflect all changes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. Make sure tests pass via `mvn clean install`.
8. (Optional) If the contribution is large, please file an Apache ICLA
- http://apache.org/licenses/icla.pdf
-->
### Purpose
<!--
-->
Hey, the purpose of these changes is to add additional documentation to assist newcomers more easily in launching and interacting with streapipes 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@streampipes.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [streampipes-website] bossenti merged pull request #105: Updating Beginner Documentation
Posted by "bossenti (via GitHub)" <gi...@apache.org>.
bossenti merged PR #105:
URL: https://github.com/apache/streampipes-website/pull/105
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@streampipes.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [streampipes-website] bossenti commented on pull request #105: Updating Beginner Documentation
Posted by "bossenti (via GitHub)" <gi...@apache.org>.
bossenti commented on PR #105:
URL: https://github.com/apache/streampipes-website/pull/105#issuecomment-1711451936
thanks a lot for these improvements @lab596 🙏🏼
In case you want to update the README file in the main repo as well, you need to open there a PR as well 🙂
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@streampipes.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [streampipes-website] bossenti commented on a diff in pull request #105: Updating Beginner Documentation
Posted by "bossenti (via GitHub)" <gi...@apache.org>.
bossenti commented on code in PR #105:
URL: https://github.com/apache/streampipes-website/pull/105#discussion_r1319687370
##########
README.md:
##########
@@ -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.
Review Comment:
Why do you think we are only compatible to Node v14 to 16?
Our [PR validation](https://github.com/apache/streampipes-website/blob/dev/.github/workflows/pr-validation.yml#L16) and [deployment](https://github.com/apache/streampipes-website/blob/dev/.github/workflows/deploy-website.yml#L16) both run in Node version 18
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: dev-unsubscribe@streampipes.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org