Skip to content

Commit 606d285

Browse files
pankajagrawal16pankajagrawal16
authored
Merge pull request #1 from stevehouel/master
docs: init documentation
2 parents 28fb2d8 + 33b133f commit 606d285

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+18559
-8
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug, triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--- Provide a general summary of the issue in the Title above -->
11+
<!--- How has this issue affected you? What are you trying to accomplish? -->
12+
13+
**What were you trying to accomplish?**
14+
15+
## Expected Behavior
16+
<!--- If you're describing a bug, tell us what should happen -->
17+
<!--- If you're suggesting a change/improvement, tell us how it should work -->
18+
19+
## Current Behavior
20+
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
21+
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
22+
23+
## Possible Solution
24+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
25+
<!--- or ideas how to implement the addition or change -->
26+
27+
## Steps to Reproduce (for bugs)
28+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
29+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
30+
1.
31+
2.
32+
3.
33+
4.
34+
35+
## Environment
36+
37+
* **Powertools version used**:
38+
* **Packaging format (Layers, Maven/Gradle)**:
39+
* **AWS Lambda function runtime:**
40+
* **Debugging logs**
41+
42+
> [How to enable debug mode](https://awslabs.github.io/aws-lambda-powertools-java/#debug-mode)**
43+
44+
```java
45+
# paste logs here
46+
```

‎.github/ISSUE_TEMPLATE/documentation-improvements.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Documentation improvements
3+
about: Suggest a documentation update
4+
title: ''
5+
labels: documentation
6+
assignees: ''
7+
8+
---
9+
10+
**What were you initially searching for in the docs?**
11+
<!-- Please help us understand how you looked for information that was either not available or unclear -->
12+
13+
**Is this related to an existing part of the documentation? Please share a link**
14+
15+
**Describe how we could make it clearer**
16+
17+
**If you have a proposed update, please share it here**

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: feature-request, triage
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
**Describe the solution you'd like**
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
**Describe alternatives you've considered**
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
**Additional context**
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/rfc.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: RFC
3+
about: Feature design and proposals
4+
title: 'RFC: '
5+
labels: RFC, triage
6+
assignees: ''
7+
8+
---
9+
10+
## Key information
11+
12+
* RFC PR: (leave this empty)
13+
* Related issue(s), if known:
14+
* Area: (i.e. Tracer, Metrics, Logger, etc.)
15+
* Meet [tenets](https://awslabs.github.io/aws-lambda-powertools-java/#tenets): (Yes/no)
16+
17+
## Summary
18+
[summary]: #summary
19+
20+
> One paragraph explanation of the feature.
21+
22+
## Motivation
23+
[motivation]: #motivation
24+
25+
> Why are we doing this? What use cases does it support? What is the expected outcome?
26+
27+
## Proposal
28+
[proposal]: #proposal
29+
30+
> This is the bulk of the RFC.
31+
32+
> Explain the design in enough detail for somebody familiar with Powertools to understand it, and for somebody familiar with the implementation to implement it.
33+
34+
> This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here.
35+
36+
## Drawbacks
37+
[drawbacks]: #drawbacks
38+
39+
> Why should we *not* do this?
40+
41+
> Do we need additional dependencies? Impact performance/package size?
42+
43+
## Rationale and alternatives
44+
[rationale-and-alternatives]: #rationale-and-alternatives
45+
46+
* **What other designs have been considered? Why not them?**
47+
* **What is the impact of not doing this?**
48+
49+
## Unresolved questions
50+
[unresolved-questions]: #unresolved-questions
51+
52+
> Optional, stash area for topics that need further development e.g. TBD

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
**Issue #, if available:**
2+
3+
## Description of changes:
4+
5+
<!--- One or two sentences as a summary of what's being changed -->
6+
7+
**Checklist**
8+
9+
<!--- Leave unchecked if your change doesn't seem to apply -->
10+
11+
* [ ] [Meet tenets criteria](https://awslabs.github.io/aws-lambda-powertools-java/#tenets)
12+
* [ ] Update tests
13+
* [ ] Update docs
14+
* [ ] PR title follows [conventional commit semantics]()
15+
16+
## Breaking change checklist
17+
18+
<!--- Ignore if it's not a breaking change -->
19+
20+
**RFC issue #**:
21+
22+
* [ ] Migration process documented
23+
* [ ] Implement warnings (if it can live side by side)
24+
25+
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

‎.github/release-drafter.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
change-template: "* $TITLE (#$NUMBER) by @$AUTHOR"
2+
categories:
3+
- title: '⚡ Breaking Changes'
4+
labels:
5+
- 'breaking-change'
6+
- title: '🌟New features and non-breaking changes'
7+
labels:
8+
- 'major'
9+
- 'feature'
10+
- title: '🌟 Minor Changes'
11+
labels:
12+
- 'enhancement'
13+
- title: '📜 Documentation updates'
14+
labels:
15+
- 'documentation'
16+
- title: '🐛 Bug and hot fixes'
17+
labels:
18+
- 'bug'
19+
- 'fix'
20+
- title: '🚒 Deprecations'
21+
labels:
22+
- 'deprecated'
23+
exclude-labels:
24+
- 'skip-changelog'
25+
tag-template: 'v$NEXT_PATCH_VERSION'
26+
template: |
27+
## Changes
28+
29+
**[Human readable summary of changes]**
30+
31+
$CHANGES
32+
33+
## This release was made possible by the following contributors:
34+
35+
$CONTRIBUTORS

‎.github/semantic.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# conventional commit types: https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json
2+
types:
3+
- feat
4+
- fix
5+
- docs
6+
- style
7+
- refactor
8+
- perf
9+
- test
10+
- build
11+
- ci
12+
- chore
13+
- revert
14+
- improv
15+
16+
# Always validate the PR title
17+
# and ignore the commits to lower the entry bar for contribution
18+
# while titles make up the Release notes to ease maintenance overhead
19+
titleOnly: true

‎.github/stale.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
only: issues
2+
daysUntilStale: 30
3+
daysUntilClose: 7
4+
exemptLabels:
5+
- bug
6+
- documentation
7+
- enhancement
8+
- feature-request
9+
- RFC
10+
staleLabel: pending-close-response-required
11+
markComment: >
12+
This issue has been automatically marked as stale because it has not had
13+
recent activity. It will be closed if no further activity occurs. Thank you
14+
for your contributions.
15+
closeComment: >
16+
This issue has been automatically closed because of inactivity.
17+
Please open a new issue if you are still encountering problems.

‎.github/workflows/build.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Build
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
max-parallel: 4
14+
matrix:
15+
# test against latest update of each major Java version, as well as specific updates of LTS versions:
16+
java: [7, 7.0.181, 8, 8.0.192, 9.0.x, 10, 11.0.x, 11.0.3, 12, 13 ]
17+
name: Java ${{ matrix.java }}
18+
env:
19+
OS: ${{ matrix.os }}
20+
JAVA: ${{ matrix.java-version }}
21+
steps:
22+
- uses: actions/checkout@v2
23+
- name: Setup java
24+
uses: actions/setup-java@v1
25+
with:
26+
java-version: ${{ matrix.java }}
27+
- name: Build with Maven
28+
run: mvn -B package --file pom.xml -P release

‎.github/workflows/docs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Docs
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
10+
# Disabled until docs support versioning per branch/release
11+
# - develop
12+
13+
jobs:
14+
docs:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- uses: actions/checkout@v2
18+
- uses: borales/[email protected]
19+
- name: Set up Python
20+
uses: actions/setup-python@v1
21+
with:
22+
python-version: "3.8"
23+
- name: Capture branch and tag
24+
id: branch_name
25+
run: |
26+
echo ::set-env name=SOURCE_BRANCH::${GITHUB_REF#refs/heads/}
27+
echo ::set-env name=SOURCE_TAG::${GITHUB_REF#refs/tags/}
28+
29+
- name: install dependencies
30+
run: make dev-docs
31+
- name: Build docs website
32+
run: make build-docs-website
33+
- name: Deploy all docs
34+
uses: peaceiris/actions-gh-pages@v3
35+
with:
36+
github_token: ${{ secrets.GITHUB_TOKEN }}
37+
publish_dir: ./dist

‎.github/workflows/release-drafter.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
# branches to consider in the event; optional, defaults to all
6+
branches:
7+
- develop
8+
9+
jobs:
10+
update_release_draft:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: release-drafter/release-drafter@v5
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)