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

updated documentation to new format #214

Conversation

chrislomonico
Copy link

What this PR changes/adds

Updating the system-tests/README.md to make it more user friendly

Why it does that

General clean-up and polishing of documentation after running through the process locally

Linked Issue(s)

Closes #210

Checklist

  • added appropriate tests?
  • performed checkstyle check locally?
  • added/updated copyright headers?
  • documented public classes/methods?
  • added/updated relevant documentation?
  • added relevant details to the changelog? (skip with label no-changelog)
  • formatted title correctly?

@chrislomonico chrislomonico requested review from cpeeyush and zeier July 22, 2022 14:10
@chrislomonico chrislomonico self-assigned this Jul 22, 2022
system-tests/README.md Outdated Show resolved Hide resolved
chrislomonico and others added 2 commits July 22, 2022 16:16
Co-authored-by: Peeyush Chandel <555114+cpeeyush@users.noreply.github.com>
Copy link

@zeier zeier left a comment

Choose a reason for hiding this comment

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

Tested successfully on Windows with Java 11

@chrislomonico chrislomonico merged commit 85e83ea into feature/210/210-local-setup-doc-update Jul 22, 2022
@chrislomonico chrislomonico deleted the feature/210-setup-clean-up branch July 22, 2022 14:40
cpeeyush added a commit that referenced this pull request Jul 27, 2022
* updated documentation to new format (#214)

* updated documentation to new format

* spelling

* wording changes

* Update system-tests/README.md

Co-authored-by: Peeyush Chandel <555114+cpeeyush@users.noreply.github.com>

Co-authored-by: Peeyush Chandel <555114+cpeeyush@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>

* Address upstream comments

* added note about paths being relative

* Update system-tests/README.md

Co-authored-by: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com>

* Update system-tests/README.md

Co-authored-by: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com>

* addressed open comments

Co-authored-by: Peeyush Chandel <555114+cpeeyush@users.noreply.github.com>
Co-authored-by: Alexandre Gattiker <algattik@users.noreply.github.com>
Co-authored-by: Paul Latzelsperger <43503240+paullatzelsperger@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants