Merge pull request #24 from sliedig/develop

chore: GitHub template and Docs updates
aws-powertools · Aug 21, 2021 · ec4e660 · ec4e660
2 parents 68ab330 + f74ecdf
commit ec4e660
Show file tree

Hide file tree

Showing 9 changed files with 641 additions and 10 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -35,12 +35,9 @@ assignees: ''
 ## Environment
 
 * **Powertools version used**:
-* **Packaging format (Layers, Maven/Gradle)**:
 * **AWS Lambda function runtime:**
 * **Debugging logs**
 
-> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-dotnet/#debug-mode)**
-
-```net
+```csharp
 # paste logs here
 ```
diff --git a/.github/ISSUE_TEMPLATE/rfc.md b/.github/ISSUE_TEMPLATE/rfc.md
@@ -4,7 +4,7 @@ about: Feature design and proposals
 title: 'RFC: '
 labels: RFC, triage
 assignees: ''
-
+approved by: ''
 ---
 
 ## Key information
@@ -13,6 +13,8 @@ assignees: ''
 * Related issue(s), if known:
 * Area: (i.e. Tracer, Metrics, Logger, etc.)
 * Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-dotnet/#tenets): (Yes/no)
+* Approved by: ''
+* Reviewed by: ''
 
 ## Summary
 [summary]: #summary
@@ -31,7 +33,15 @@ assignees: ''
 
 > Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it.
 
-> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
+**If this feature should be available in other runtimes (e.g. Java, Typescript), how would this look like to ensure consistency?**
+
+## User Experience
+
+**How would customers use it?**
+
+**Any configuration or corner cases you'd expect?**
+
+**Demonstration of before and after on how the experience will be better**
 
 ## Drawbacks
 [drawbacks]: #drawbacks

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -11,7 +11,7 @@
 * [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-dotnet/#tenets)
 * [ ] Update tests
 * [ ] Update docs
-* [ ] PR title follows [conventional commit semantics]()
+* [ ] PR title follows [conventional commit semantics](https://github.com/awslabs/aws-lambda-powertools-dotnet/blob/develop/.github/semantic.yml)
 
 ## Breaking change checklist
 

diff --git a/.github/auto_assign-issues.yml b/.github/auto_assign-issues.yml
@@ -0,0 +1,7 @@
+addAssignees: true
+
+# The list of users to assign to new issues.
+# If empty or not provided, the repository owner is assigned
+assignees:
+  - t1agob
+  - sliedig
diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml
@@ -0,0 +1,45 @@
+##### Labeler ##########################################################################################################
+labelPRBasedOnFilePath:
+  area/logger:
+    - libraries/src/AWS.Lambda.PowerTools.Logging/*
+    - libraries/src/AWS.Lambda.PowerTools.Logging/**/*
+  area/tracer:
+    - libraries/src/AWS.Lambda.PowerTools.Tracing/*
+    - libraries/src/AWS.Lambda.PowerTools.Tracing/**/*
+  area/metrics:
+    - libraries/src/AWS.Lambda.PowerTools.Metrics/*
+    - libraries/src/AWS.Lambda.PowerTools.Metrics/**/*
+
+  documentation:
+    - docs/*
+    - docs/**/*
+    - mkdocs.yml
+
+  internal:
+    - .github/*
+    - .github/**/*
+    - .chglog/*
+    - .flake8
+    - .gitignore
+    - .pre-commit-config.yaml
+    - Makefile
+    - CONTRIBUTING.md
+    - CODE_OF_CONDUCT.md
+    - LICENSE
+
+  tests:
+    - libraries/tests/*
+    - libraries/tests/**/*
+
+
+##### Greetings ########################################################################################################
+firstPRWelcomeComment: >
+  Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
+
+# Comment to be posted to congratulate user on their first merged PR
+firstPRMergeComment: >
+  Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!
+
+# Comment to be posted to on first time issues
+firstIssueWelcomeComment: >
+  Thanks for opening your first issue here! We'll come back to you as soon as we can.
diff --git a/404.html b/404.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <script>
+        const websitePath = window.location.pathname;
+        const versionRegex = /(\w.+)\/(latest|([0-9]+)\.([0-9]+)\.([0-9]+)(?:-([0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*))?(?:\+[0-9A-Za-z-]+)?)/;
+
+        if (websitePath.search(versionRegex) === -1) {
+            let projectName = "aws-lambda-powertools-dotnet"
+            // redirect old links to latest version alias
+            window.location = websitePath.replace(projectName, `${projectName}/latest`)
+        }
+    </script>
+</head>
+
+</html>
diff --git a/Makefile b/Makefile
@@ -2,11 +2,9 @@
 
 release-docs:
 	@echo "Rebuilding docs"
-	rm -rf site api
+	rm -rf site
 	@echo "Updating website docs"
 	poetry run mike deploy --push --update-aliases ${VERSION} ${ALIAS}
-	@echo "Building API docs"
-	@$(MAKE) build-docs-api
 
 build-docs-api:
 	poetry run pdoc --html --output-dir ./api/ ./aws_lambda_powertools --force