Skip to content

Commit 3cc8586

Browse files
timkimtimkim
authored
Initial commit
0 parents  commit 3cc8586

40 files changed

+23431
-0
lines changed

‎.env.example

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
REPO_GITHUB_TOKEN=
2+
REPO_OWNER=AdobeDocs
3+
REPO_NAME=dev-site-documentation-template
4+
REPO_BRANCH=main

‎.github/CONTRIBUTING.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
Thanks for choosing to contribute!
4+
5+
The following are a set of guidelines to follow when contributing to this project.
6+
7+
## Code Of Conduct
8+
9+
This project adheres to the Adobe [code of conduct](../CODE_OF_CONDUCT.md). By participating,
10+
you are expected to uphold this code. Please report unacceptable behavior to
11+
[[email protected]](mailto:[email protected]).
12+
13+
## Have A Question?
14+
15+
Start by filing an issue. The existing committers on this project work to reach
16+
consensus around project direction and issue solutions within issue threads
17+
(when appropriate).
18+
19+
## Contributor License Agreement
20+
21+
All third-party contributions to this project must be accompanied by a signed contributor
22+
license agreement. This gives Adobe permission to redistribute your contributions
23+
as part of the project. [Sign our CLA](https://opensource.adobe.com/cla.html). You
24+
only need to submit an Adobe CLA one time, so if you have submitted one previously,
25+
you are good to go!
26+
27+
## Code Reviews
28+
29+
All submissions should come in the form of pull requests and need to be reviewed
30+
by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
31+
for more information on sending pull requests.
32+
33+
Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when
34+
submitting a pull request!
35+
36+
## From Contributor To Committer
37+
38+
We love contributions from our community! If you'd like to go a step beyond contributor
39+
and become a committer with full write access and a say in the project, you must
40+
be invited to the project. The existing committers employ an internal nomination
41+
process that must reach lazy consensus (silence is approval) before invitations
42+
are issued. If you feel you are qualified and want to get more deeply involved,
43+
feel free to reach out to existing committers to have a conversation about that.
44+
45+
## Security Issues
46+
47+
Security issues shouldn't be reported on this issue tracker. Instead, [file an issue to our security experts](https://helpx.adobe.com/security/alertus.html).

‎.github/ISSUE_TEMPLATE.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!--- STOP! Before you open an issue please search this repository's issues to see if it has already been reported. This helps reduce duplicate issues from being created. -->
2+
<!--- SECURITY DISCLOSURE: If this is a security disclosure please follow the guidelines in CONTRIBUTING.md. This helps keep folks from accidentally releasing vulnerabilities before the maintainers get a chance to fix the issue. -->
3+
4+
### Expected Behaviour
5+
6+
### Actual Behaviour
7+
8+
### Reproduce Scenario (including but not limited to)
9+
10+
#### Steps to Reproduce
11+
12+
#### Platform and Version
13+
14+
#### Sample Code that illustrates the problem
15+
16+
#### Logs taken while reproducing problem

‎.github/ISSUE_TEMPLATE/config.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: Help Center
5+
url: https://helpx.adobe.com/support.html
6+
about: Find help with issues unrelated to documentation here.
7+
- name: Community resources
8+
url: https://developer.adobe.com/open
9+
about: Find more resources here.
10+
- name: Adobe Developer Support
11+
url: https://developer.adobe.com/developer-support
12+
about: Ask and answer questions.

‎.github/ISSUE_TEMPLATE/incorrect_topic.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Incorrect or unclear topic
2+
description: "Unclear or incorrect documentation: ambiguous guidelines, wrong or obsolete examples, typos, etc."
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for taking the time to report this issue!
8+
This request should only relate to the content of the developer.adobe.com website.
9+
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the documentation you are requesting.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
- type: input
18+
attributes:
19+
label: Which topic?
20+
description: A link to the topic that needs clarification or correction
21+
placeholder: "Example: https://developer.adobe.com/commerce/webapi/rest/use-rest/search-endpoint/"
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: What's wrong with the content?
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: What changes do you propose?
32+
- type: textarea
33+
attributes:
34+
label: Anything else that can help to cover this?

‎.github/ISSUE_TEMPLATE/missing_content.yaml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Missing content
2+
description: Undocumented feature, service, command, API, UI component, procedure, etc.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for taking the time to report this issue!
8+
This request should only relate to the content of the developer.adobe.com website.
9+
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the documentation you are requesting.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: What's missing?
20+
placeholder: |
21+
- In the <guide name> or <page link> ...
22+
- Missing explanation of how ... works.
23+
- Missing steps or guidelines for ....
24+
- Missing code samples to demonstrate ....
25+
- Something else ...
26+
validations:
27+
required: true

‎.github/ISSUE_TEMPLATE/site_bug.yaml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
name: Site bug
2+
description: Something isn't working on developer.adobe.com or when building the website locally.
3+
labels: ["bug"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for taking the time to report this issue!
9+
This bug report should only relate to the developer.adobe.com website itself or non-content issues such as rendering, 404 pages, or other unexpected behavior.
10+
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
11+
SECURITY DISCLOSURE: If this is a security disclosure please follow the guidelines in CONTRIBUTING.md. This helps keep folks from accidentally releasing vulnerabilities before the maintainers get a chance to fix the issue.
12+
- type: checkboxes
13+
attributes:
14+
label: Is there an existing issue for this?
15+
description: Please search to see if an issue already exists for the bug you encountered.
16+
options:
17+
- label: I have searched the existing issues
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Expected behavior
22+
description: |
23+
Tell us what you expected to happen.
24+
validations:
25+
required: true
26+
- type: textarea
27+
attributes:
28+
label: Actual behavior
29+
description: |
30+
Tell us what happened. Include error messages and issues.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Steps to reproduce
36+
description: |
37+
Provide a set of clear steps to reproduce this bug.
38+
validations:
39+
required: true
40+
- type: textarea
41+
attributes:
42+
label: Environment
43+
description: |
44+
Describe your environment such as platform, browser, and versions.
45+
Provide all the details that will help us to reproduce the bug.
46+
value: |
47+
- Browser:
48+
- OS:
49+
validations:
50+
required: true
51+
- type: textarea
52+
attributes:
53+
label: Sample code
54+
description: Sample Code that illustrates the problem
55+
- type: textarea
56+
attributes:
57+
label: Logs
58+
description: Logs taken while reproducing problem

‎.github/ISSUE_TEMPLATE/site_feature.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
name: Site feature request
2+
description: Propose a new functionality or an improvement of the developer.adobe.com website or of the local development tools.
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for taking the time to report this issue!
8+
This feature request should only relate to the developer.adobe.com website itself and its behavior.
9+
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the feature you are requesting.
14+
options:
15+
- label: I have searched the existing issues
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: What feature should be added?
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: What is the expected behavior?
25+
validations:
26+
required: true
27+
- type: textarea
28+
attributes:
29+
label: How will this feature improve the user experience?
30+
validations:
31+
required: true
32+
- type: textarea
33+
attributes:
34+
label: What would a solution for this issue look like?

‎.github/PULL_REQUEST_TEMPLATE.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<!--- Provide a general summary of your changes in the Title above -->
2+
3+
## Description
4+
5+
<!--- Describe your changes in detail -->
6+
7+
## Related Issue
8+
9+
<!--- This project only accepts pull requests related to open issues -->
10+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
11+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
12+
<!--- Please link to the issue here: -->
13+
14+
## Motivation and Context
15+
16+
<!--- Why is this change required? What problem does it solve? -->
17+
18+
## How Has This Been Tested?
19+
20+
<!--- Please describe in detail how you tested your changes. -->
21+
<!--- Include details of your testing environment, and the tests you ran to -->
22+
<!--- see how your change affects other areas of the code, etc. -->
23+
24+
## Screenshots (if appropriate):
25+
26+
## Types of changes
27+
28+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
29+
30+
- [ ] Bug fix (non-breaking change which fixes an issue)
31+
- [ ] New feature (non-breaking change which adds functionality)
32+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
33+
34+
## Checklist:
35+
36+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
37+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
38+
39+
- [ ] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html).
40+
- [ ] My code follows the code style of this project.
41+
- [ ] My change requires a change to the documentation.
42+
- [ ] I have updated the documentation accordingly.
43+
- [ ] I have read the **CONTRIBUTING** document.
44+
- [ ] I have added tests to cover my changes.
45+
- [ ] All new and existing tests passed.

‎.github/dependabot.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
version: 2
2+
updates:
3+
# Enable version updates for npm
4+
- package-ecosystem: "npm"
5+
# Look for `package.json` and `lock` files in the `root` directory
6+
directory: "/"
7+
# Check the npm registry for updates every day (weekdays)
8+
schedule:
9+
interval: "daily"
10+
versioning-strategy: increase
11+
open-pull-requests-limit: 25
12+
labels:
13+
- "dependencies"
14+
ignore:
15+
# Ignore updates to package
16+
- dependency-name: "gatsby"

‎.github/linters/.markdown-lint.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
###########################
3+
###########################
4+
## Markdown Linter rules ##
5+
###########################
6+
###########################
7+
8+
# Linter rules doc:
9+
# - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
10+
#
11+
# Note:
12+
# To comment out a single error:
13+
# <!-- markdownlint-disable -->
14+
# any violations you want
15+
# <!-- markdownlint-restore -->
16+
#
17+
18+
# Default state for all rules
19+
default: false
20+
21+
#################
22+
# Rules by tags #
23+
#################
24+
blanks-around-fences: true # Fenced code blocks should be surrounded by blank lines
25+
blanks-around-headings: true # Headings should be surrounded by blank lines
26+
blanks-around-lists: true # Lists should be surrounded by blank lines
27+
code-block-style:
28+
style: "fenced"
29+
code-fence-style:
30+
style: "backtick"
31+
emphasis-style:
32+
style: "consistent"
33+
fenced-code-language: true # Fenced code blocks should have a language specified
34+
heading-start-left: true # Headings must start at the beginning of the line
35+
heading-style:
36+
style: "atx"
37+
hr-style: true # Horizontal rule style
38+
list-indent: true # Inconsistent indentation for list items at the same level
39+
no-empty-links: true
40+
no-missing-space-atx: true # No space after hash on atx style heading
41+
no-multiple-blanks: true # Multiple consecutive blank lines
42+
no-reversed-links: true
43+
no-space-in-code: true
44+
no-space-in-emphasis: true
45+
no-space-in-links: true
46+
no-trailing-spaces: true
47+
single-trailing-newline: true # Files should end with a single newline character
48+
strong-style:
49+
style: "consistent"
50+
ul-style:
51+
style: "consistent"

0 commit comments

Comments
 (0)