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

Tutorial documentation #2

Merged
merged 20 commits into from
Sep 24, 2021
Merged

Tutorial documentation #2

merged 20 commits into from
Sep 24, 2021

Conversation

Chris-Schnaufer
Copy link
Member

@Chris-Schnaufer Chris-Schnaufer commented Aug 18, 2021

Description

Initial tutorial documentation

To run an instance of the website (with workflows) on your local machine. After starting instance, browse to http://localhost:3000/

docker run --rm -p 3000:3000 --name test agdrone/workflow_web_ui:1.0

Types of changes

New dowcumentation

Checklist:

  • I have read the documentation on CONTRIBUTING
  • My updates require a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

Time frame for completing Pull Request review (from creation date):

  • As soon as possible
  • In the next two weeks
  • In the next month

Focus of Pull Request:

Reviewers should focus on the following aspects of this pull request. All comments are welcome regardless of which items are checked off.

  • Inform others of new features and changes
  • There are no errors or inconsistencies
  • Everything appears clear and easy to understand
  • Suggest improvements
  • Identify areas where functionality and/or documentation is missing

Hints to reviewers:

New documentation to be reviewed

Optional: issue links this Pull Request resolves

Copy link
Contributor

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

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

Looks like a great start!

  • made some minor suggestions to the text
  • a few questions for clarity
  • some comments may warrant new issues if changes to UI and naming are requested

Chris-Schnaufer and others added 4 commits September 9, 2021 13:44
Co-authored-by: David LeBauer <[email protected]>
Co-authored-by: David LeBauer <[email protected]>
Co-authored-by: David LeBauer <[email protected]>
Co-authored-by: David LeBauer <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Sep 17, 2021

Codecov Report

❗ No coverage uploaded for pull request base (develop@0c175e4). Click here to learn what that means.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             develop       #2   +/-   ##
==========================================
  Coverage           ?   34.31%           
==========================================
  Files              ?        8           
  Lines              ?     2838           
  Branches           ?        0           
==========================================
  Hits               ?      974           
  Misses             ?     1864           
  Partials           ?        0           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0c175e4...1a50153. Read the comment docs.

Copy link
Contributor

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

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

this looks great. Can merge if you create issues to clarify the language used in the interface.

@Chris-Schnaufer Chris-Schnaufer merged commit 7d27560 into develop Sep 24, 2021
@Chris-Schnaufer Chris-Schnaufer deleted the documentation branch September 24, 2021 20:53
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