documentation_request.yml

# 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 Request
description: Request updates or additions to cuSpatial's documentation
title: "[DOC]: "
labels: ["doc", "? - Needs Triage"]

body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to help cuSpatial and improve our documentation!
        - By submitting this issue, you agree to follow our [Code of Conduct](https://docs.rapids.ai/resources/conduct/)
        - You also confirm that you have searched the [open documentation issues](https://github.com/rapidsai/cuspatial/issues?q=is%3Aopen+is%3Aissue+label%3Adoc) and have found no duplicates for this request

  - 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: dropdown
    id: new_or_correction
    attributes:
      label: Is this for new documentation, or an update to existing docs?
      options:
        - New
        - Update
    validations:
      required: true

  - type: textarea
    id: problem
    attributes:
      label: Describe the incorrect/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? If a correction, where did you find the issue?
      placeholder: |
       https://docs.rapids.ai/api/cuspatial/stable/ and
       https://docs.rapids.ai/api/cuspatial/nightly