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

Restore missing documentation about how to test runtimes standalone. #227

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

Rurouni-Jiaxin
Copy link

@Rurouni-Jiaxin Rurouni-Jiaxin commented Oct 31, 2022

In this repo, the instructions on building and running the standalone runtime container is missing. Therefore this PR is created to fix that. @mrutkows review-requested:mrutkows

@Rurouni-Jiaxin Rurouni-Jiaxin marked this pull request as draft October 31, 2022 13:34
@Rurouni-Jiaxin Rurouni-Jiaxin marked this pull request as ready for review October 31, 2022 13:35
@mrutkows
Copy link
Contributor

mrutkows commented Nov 11, 2022

@Rurouni-Jiaxin Would it be possible to

  1. update the top-level README.md to link to this "standalone" README?
    Perhaps under the https://github.com/apache/openwhisk-runtime-nodejs#testing section.

  2. Also, you may want to relocate your markdown to the "docs/user" dir. (e.g., https://github.com/apache/openwhisk-runtime-nodejs/blob/master/docs/users/)

  3. If you would kindly work in the 3 use cases (and link to their json data files) from here: https://github.com/apache/openwhisk-runtime-nodejs/tree/master/tests/src/test/knative that would be great!

@mrutkows
Copy link
Contributor

@Rurouni-Jiaxin you may want to look at this closed PR from a while ago which would have added pre-reqs and other info, that may be helpful (applied) to your new doc.
https://github.com/apache/openwhisk-runtime-nodejs/pull/190/files

.github/workflows/ci.yaml Outdated Show resolved Hide resolved
docs/users/standalone/README.md Outdated Show resolved Hide resolved
@Rurouni-Jiaxin Rurouni-Jiaxin force-pushed the jfan/document/test branch 2 times, most recently from 7f37442 to 03a8541 Compare January 30, 2023 19:13
Jiaxin Fan added 3 commits January 30, 2023 20:33
Revised README, also add EOL at end of file

Attempt to fix trailing white space

Checked for typos

Fix minor formatting error, test Git still works

WIP: update top-level README
tests/src/test/standalone/README.md Outdated Show resolved Hide resolved
tests/src/test/standalone/README.md Outdated Show resolved Hide resolved
tests/src/test/standalone/README.md Outdated Show resolved Hide resolved
docs/users/standalone/README.md Outdated Show resolved Hide resolved
Add CI status

Rebase resolved

Squash commits

Update top level README

Rollback changes to ci.yaml
Jiaxin Fan added 2 commits February 6, 2023 14:06
add EOL

Fix filepath in curl command
@mrutkows
Copy link
Contributor

mrutkows commented Feb 6, 2023 via email

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.

3 participants