Skip to content

Commit

Permalink
Merge branch 'uptane:uptane_docusaurus' into ag_dev_gtag
Browse files Browse the repository at this point in the history
  • Loading branch information
devilkiller-ag authored Oct 26, 2023
2 parents 76ca87f + b2658bb commit 284575b
Show file tree
Hide file tree
Showing 6 changed files with 181 additions and 3 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 🐞 Bug Report
description: Create a report to help us improve
title: "[Bug Report] - <title>"
labels: ["bug","triage"]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Bug report! Please fill out the report and replace the '<title>' text in the title with a short description of the issue.
- type: textarea
attributes:
label: Describe the bug.
description: "Enter a clear and concise description of the bug."
validations:
required: true
- type: textarea
attributes:
label: Describe the steps to reproduce the behavior.
description: "Clearly and concisely describe the steps to ensure that it can be reproduced and potentially fixed."
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
attributes:
label: Expected behavior.
description: "Enter a clear and concise description of what you expected to happen."
- type: textarea
attributes:
label: Screenshots.
description: "If applicable, add screenshots to help explain your problem."
- type: input
attributes:
label: Operating environment
description: "What operating system and version are you using?"
placeholder: |
Ubuntu 20.04.1 LTS
validations:
required: true
- type: dropdown
attributes:
label: What browsers are you seeing the problem on?
multiple: true
options:
- Firefox
- Chrome
- Safari
- Microsoft Edge
- Other
- type: textarea
attributes:
label: Additional context
description: "Add any other context or screenshots to clarify your suggestion here."
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Documentation
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 report for our Documentation!
- type: textarea
attributes:
label: Issue Summary
description: "Add a brief description of the documentation issue."
- type: textarea
attributes:
label: Where is this stated?
description: "Provide additional information about the location where you found the issue. You can include any relevant links or files."
- type: textarea
attributes:
label: Why does this need improvement?
description: "Please include more detail about the issue. Is the wording confusing or incorrect? Does it have spelling/grammatical errors?, etc."
- type: textarea
attributes:
label: Suggested Improvement
description: "If you have a suggestion for how to resolve the issue, please describe it here."
- type: textarea
attributes:
label: Additional context.
description: "Add any other context or useful information about the documentation issue here."
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature Request
description: Suggest an idea for this project
title: "Feature Request: "
labels: [enhancement]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Feature Request report!
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: 'A clear and concise description of what the problem is. Ex. I am always frustrated when [...]'
- type: textarea
attributes:
label: Describe how you would like this problem to be resolved
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 about the feature request here.'
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/other-issues.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Other Issues
description: Other comments or suggestions for improvement
title: "Other: "
labels: [other]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file this report!
- type: textarea
attributes:
label: Issue Summary
description: "Add a brief description of the issue or request."
- type: textarea
attributes:
label: Details
description: "Provide additional details or context about the issue or request."
- type: dropdown
attributes:
label: Priority Level
description: "Indicate the priority level of the issue (e.g., low, medium, high)."
multiple: true
options:
- Low
- Medium
- High
- type: textarea
attributes:
label: Proposed Solution (if any)
description: "If you have a suggestion for how to resolve the issue or fulfill the request, please describe it here."
- type: textarea
attributes:
label: Related Information
description: "Include relevant links or references that can help us understand or address the issue. Or attach any files or media that might be relevant to this issue."
- type: textarea
attributes:
label: Additional Comments
description: "Add any extra comments or context for discussion."
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

# Summary of Changes

Describe the changes or improvements made in this pull request.

## Related Issue

Closes #<issue-number>

## Checklist

- [ ] I have read and followed the [project's contribution guidelines](https://github.com/secure-systems-lab/lab-guidelines/blob/master/dev-workflow.md), including code style and commit message conventions.
- [ ] My code is well-documented, and I've updated relevant documentation.
- [ ] I have added or updated test cases to ensure the code's functionality.
- [ ] I have tested these changes on my local environment.
- [ ] All tests pass, and there are no new linting errors.
- [ ] I have reviewed and proofread my code and the changes.
- [ ] The branch is up-to-date with the base branch.

## Screenshots (if applicable)

Attach any screenshots or images related to the changes.

## Additional Context

Add any additional context or information that might be helpful for reviewers.

## Reviewer(s)

@mention any specific reviewers or tag relevant team members.
7 changes: 4 additions & 3 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,10 @@ const config = {
maxHeadingLevel: 5,
},
algolia: {
apiKey: "#",
appId: "#",
indexName: "#",
appId: "WZ6MBDOHOT",
apiKey: "426b6390ff8a971f493d017aef9d9e0a",
indexName: "uptaneio",
contextualSearch: true,
},
navbar: {
logo: {
Expand Down

0 comments on commit 284575b

Please sign in to comment.