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.

Sign up for GitHub

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

Jump to bottom

Updated/new documentation for custom nodes, CLI, tests #83

Merged
merged 6 commits into from
May 6, 2020
Merged

Updated/new documentation for custom nodes, CLI, tests #83

merged 6 commits into from
May 6, 2020

Conversation

reelmatt
Copy link
Member

@reelmatt reelmatt commented May 3, 2020

Updated the main README to include:

  • A table of badges for existing/TBD tests
  • Changed wording to reflect what PyWorkflow aims to do, heavily influenced by the Milestone 2 report.
  • Updated code styles to code-blocks instead of inline code snippets.
  • Reflects some TBD features like Docker functionality and still in-progress CLI features.

Adds new doc files for:

  • CLI: purpose, syntax, and using stdin/stdout
  • Test: moved most of the details from the main README to a separate file. To be expanded later.
  • Custom nodes: how to write a custom node with examples and greater detail than previously existed.

Labeling this as a work in progress since some of this reflects some functionality that's not yet finished and may be subject to change.

@reelmatt reelmatt added the documentation Improvements or additions to documentation label May 3, 2020
@reelmatt reelmatt marked this pull request as ready for review May 6, 2020 01:37
@reelmatt reelmatt changed the title WIP: Updated/new documentation for custom nodes, CLI, tests Updated/new documentation for custom nodes, CLI, tests May 6, 2020
diegostruk
diegostruk approved these changes May 6, 2020
View reviewed changes
Copy link
Collaborator

@diegostruk diegostruk left a comment

Choose a reason for hiding this comment

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

Looks great!

reddigari
reddigari approved these changes May 6, 2020
View reviewed changes
README.md Outdated
If you write custom nodes that require additional packages, you can add these
to the Docker image by running:
```
docker exec pipenv install [package-name]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's remove this until we figure out if it will work

README.md Outdated
`docker-compose up`

This builds both the front- and back-end Docker images and runs them with
networking between the images. To use the GUI, open http://localhost:3000 in your
Copy link
Collaborator

Choose a reason for hiding this comment

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

nitpick: the running process is a container, the static (downloadable) artifact is the image

@reddigari
Copy link
Collaborator

Really great documentation!

@reddigari reddigari merged commit d35ce87 into master May 6, 2020
@reelmatt reelmatt deleted the dev/mthomas branch May 6, 2020 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@reddigari reddigari reddigari approved these changes

@diegostruk diegostruk diegostruk approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@reelmatt @reddigari @diegostruk @hcat-pge