Skip to content

Commit

Permalink
Merge pull request #212 from nv-morpheus/branch-22.11
Browse files Browse the repository at this point in the history
[RELEASE] SRF v22.11
  • Loading branch information
mdemoret-nv authored Nov 19, 2022
2 parents 5d9d8fd + 696244b commit 239d54a
Show file tree
Hide file tree
Showing 107 changed files with 6,630 additions and 1,146 deletions.
28 changes: 0 additions & 28 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Bug Report
description: File a bug report
title: "[BUG]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: version
attributes:
label: Version
description: What version of SRF are you running?
placeholder: "example: 22.09"
validations:
required: true

- type: dropdown
id: installation-method
attributes:
label: Which installation method(s) does this occur on?
multiple: true
options:
- Docker
- Conda
- Source

- type: textarea
id: description
attributes:
label: Describe the bug.
description: Also tell us, what did you expect to happen?
placeholder: XYZ occured, I expected QRS results
validations:
required: true

- type: textarea
id: mvr
attributes:
label: Minimum reproducible example
description: Please supply a [minimum reproducible code example](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) here
render: shell

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please paste relevant error and log output here
render: shell

- type: textarea
id: env-printout
attributes:
label: Full env printout
description: Please run and paste the output of the `./scripts/print_env.sh` script here, to gather any other relevant environment details
render: shell

- type: textarea
id: misc
attributes:
label: Other/Misc.
description: Please enter any other helpful information here.

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nv-morpheus/SRF/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow SRF's Code of Conduct
required: true
- label: I have searched the [open bugs](https://github.com/nv-morpheus/SRF/issues?q=is%3Aopen+is%3Aissue+label%3Abug) and have found no duplicates for this bug report
required: true
35 changes: 0 additions & 35 deletions .github/ISSUE_TEMPLATE/documentation-request.md

This file was deleted.

70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_correction.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Documentation - Correction/Update Request
description: Request corrections or updates to existing documentation
title: "[DOC]: "
labels: ["doc"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve our documentation!
- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this documentation request
options:
- Critical (currently preventing usage)
- High
- Medium
- Low (would be nice)
validations:
required: true

- type: input
id: correction_location
attributes:
label: Please provide a link or source to the relevant docs
placeholder: "ex: https://github.com/nv-morpheus/SRF/blob/main/README.md"
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the problems in the documentation
placeholder: The documents say to use foo.func(args) however an AttributeError is thrown
validations:
required: true

- type: textarea
id: correction
attributes:
label: (Optional) Propose a correction
placeholder: foo.func() was deprecated, replace documentation with foo.new_func()

- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nv-morpheus/SRF/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow SRF's Code of Conduct
required: true
- label: I have searched the [open documentation issues](https://github.com/nv-morpheus/SRF/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
required: true
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request_new.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# SPDX-FileCopyrightText: Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

name: Documentation - New Documentation Request
description: Request additions to Morpheus documentation
title: "[DOC]: "
labels: ["doc"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to improve our documentation!
- type: dropdown
id: criticality
attributes:
label: How would you describe the priority of this documentation request
options:
- Critical (currently preventing usage)
- High
- Medium
- Low (would be nice)
validations:
required: true

- type: textarea
id: problem
attributes:
label: Describe the future/missing documentation
placeholder: A code snippet mentions function foo(args) but I cannot find any documentation on it.
validations:
required: true

- type: textarea
id: search_locs
attributes:
label: Where have you looked?
placeholder: |
https://github.com/nv-morpheus/SRF/blob/main/docs/quickstart/README.md and
https://github.com/nv-morpheus/SRF/blob/main/README.md
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nv-morpheus/SRF/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow SRF's Code of Conduct
required: true
- label: I have searched the [open documentation issues](https://github.com/nv-morpheus/SRF/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this bug report
required: true
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

Loading

0 comments on commit 239d54a

Please sign in to comment.