diff --git a/.github/ISSUE_TEMPLATE/communication-suggestion.yml b/.github/ISSUE_TEMPLATE/communication-suggestion.yml new file mode 100644 index 0000000..f5b6a9b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/communication-suggestion.yml @@ -0,0 +1,25 @@ +name: Communication Suggestion +description: Propose a way to better communicate a feature +title: "Communication Suggestion: " +labels: [communication] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Communication Suggestion report. + - type: textarea + attributes: + label: Describe how we are communicating and why it is not optimal. + description: "A clear and concise description of what the problem is. Ex. When I reach this point, I cannot [...]." + - type: textarea + attributes: + label: Describe the solution you'd like. + description: "A clear and concise description of what you want to happen." + - type: textarea + attributes: + label: Describe alternatives you've considered. + description: "A clear and concise description of any alternative solutions or features you have considered." + - type: textarea + attributes: + label: Additional context. + description: "Add any other context or screenshots to clarify your suggestion here." \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation-update.yml b/.github/ISSUE_TEMPLATE/documentation-update.yml new file mode 100644 index 0000000..cf230a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-update.yml @@ -0,0 +1,29 @@ +name: Documentation Update📄 +description: Suggest how we can improve our documentation +title: "Documentation📄: " +labels: [documentation] + +body: + - type: markdown + attributes: + value: Thank you for taking the time to file a Documentation update report. + - type: textarea + attributes: + label: What is the current documentation state? + description: "Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original." + - type: textarea + attributes: + label: Where is this stated? + description: "Provide additional information about the location where you have copied the above statement from." + - type: textarea + attributes: + label: Why do you want to improve the statement? + description: "Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc." + - type: textarea + attributes: + label: Proposed Statement + description: "Please propose how you would rewrite the statement. If you have a precise proposal, please make the changes and open a pull request." + - type: textarea + attributes: + label: Additional context. + description: "Add any other context or useful information about the documentation update here." \ No newline at end of file diff --git a/README.md b/README.md index 4ea20ed..12e4e6f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,6 @@ -# user-docs -Repository to hold user docs for fossology project. +# Fossology documentation + +This repository contains developer documentation for the [fossology](https://www.fossology.org/) organization. + +Issues and contributions for the developer documentation are tracked here. We have a large community using these resources and we would like to make it our best effort to respond to issues in a timely fashion. +