Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
dianeba3 authored Dec 6, 2024
0 parents commit e305902
Show file tree
Hide file tree
Showing 44 changed files with 25,467 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
REPO_GITHUB_TOKEN=
REPO_OWNER=AdobeDocs
REPO_NAME=dev-site-documentation-template
REPO_BRANCH=main
47 changes: 47 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Contributing

Thanks for choosing to contribute!

The following are a set of guidelines to follow when contributing to this project.

## Code Of Conduct

This project adheres to the Adobe [code of conduct](../CODE_OF_CONDUCT.md). By participating,
you are expected to uphold this code. Please report unacceptable behavior to
[[email protected]](mailto:[email protected]).

## Have A Question?

Start by filing an issue. The existing committers on this project work to reach
consensus around project direction and issue solutions within issue threads
(when appropriate).

## Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor
license agreement. This gives Adobe permission to redistribute your contributions
as part of the project. [Sign our CLA](https://opensource.adobe.com/cla.html). You
only need to submit an Adobe CLA one time, so if you have submitted one previously,
you are good to go!

## Code Reviews

All submissions should come in the form of pull requests and need to be reviewed
by project committers. Read [GitHub's pull request documentation](https://help.github.com/articles/about-pull-requests/)
for more information on sending pull requests.

Lastly, please follow the [pull request template](PULL_REQUEST_TEMPLATE.md) when
submitting a pull request!

## From Contributor To Committer

We love contributions from our community! If you'd like to go a step beyond contributor
and become a committer with full write access and a say in the project, you must
be invited to the project. The existing committers employ an internal nomination
process that must reach lazy consensus (silence is approval) before invitations
are issued. If you feel you are qualified and want to get more deeply involved,
feel free to reach out to existing committers to have a conversation about that.

## Security Issues

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).
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!--- 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. -->
<!--- 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. -->

### Expected Behaviour

### Actual Behaviour

### Reproduce Scenario (including but not limited to)

#### Steps to Reproduce

#### Platform and Version

#### Sample Code that illustrates the problem

#### Logs taken while reproducing problem
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
blank_issues_enabled: false
contact_links:
- name: Help Center
url: https://helpx.adobe.com/support.html
about: Find help with issues unrelated to documentation here.
- name: Community resources
url: https://developer.adobe.com/open
about: Find more resources here.
- name: Adobe Developer Support
url: https://developer.adobe.com/developer-support
about: Ask and answer questions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/incorrect_topic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Incorrect or unclear topic
description: "Unclear or incorrect documentation: ambiguous guidelines, wrong or obsolete examples, typos, etc."
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This request should only relate to the content of the developer.adobe.com website.
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the documentation you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: input
attributes:
label: Which topic?
description: A link to the topic that needs clarification or correction
placeholder: "Example: https://developer.adobe.com/commerce/webapi/rest/use-rest/search-endpoint/"
validations:
required: true
- type: textarea
attributes:
label: What's wrong with the content?
validations:
required: true
- type: textarea
attributes:
label: What changes do you propose?
- type: textarea
attributes:
label: Anything else that can help to cover this?
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/missing_content.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Missing content
description: Undocumented feature, service, command, API, UI component, procedure, etc.
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This request should only relate to the content of the developer.adobe.com website.
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the documentation you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What's missing?
placeholder: |
- In the <guide name> or <page link> ...
- Missing explanation of how ... works.
- Missing steps or guidelines for ....
- Missing code samples to demonstrate ....
- Something else ...
validations:
required: true
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/site_bug.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Site bug
description: Something isn't working on developer.adobe.com or when building the website locally.
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
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.
Issues that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
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.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Expected behavior
description: |
Tell us what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behavior
description: |
Tell us what happened. Include error messages and issues.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
Provide a set of clear steps to reproduce this bug.
validations:
required: true
- type: textarea
attributes:
label: Environment
description: |
Describe your environment such as platform, browser, and versions.
Provide all the details that will help us to reproduce the bug.
value: |
- Browser:
- OS:
validations:
required: true
- type: textarea
attributes:
label: Sample code
description: Sample Code that illustrates the problem
- type: textarea
attributes:
label: Logs
description: Logs taken while reproducing problem
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/site_feature.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Site feature request
description: Propose a new functionality or an improvement of the developer.adobe.com website or of the local development tools.
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this issue!
This feature request should only relate to the developer.adobe.com website itself and its behavior.
Requests that do not comply with our Code of Conduct or do not contain enough information may be closed at the maintainers' discretion.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the feature you are requesting.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: What feature should be added?
validations:
required: true
- type: textarea
attributes:
label: What is the expected behavior?
validations:
required: true
- type: textarea
attributes:
label: How will this feature improve the user experience?
validations:
required: true
- type: textarea
attributes:
label: What would a solution for this issue look like?
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description

<!--- Describe your changes in detail -->

## Related Issue

<!--- This project only accepts pull requests related to open issues -->
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here: -->

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] I have signed the [Adobe Open Source CLA](https://opensource.adobe.com/cla.html).
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read the **CONTRIBUTING** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
18 changes: 18 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
version: 2
updates:
# Enable version updates for npm
- package-ecosystem: "npm"
# Look for `package.json` and `lock` files in the `root` directory
directory: "/"
# Check the npm registry for updates every day (weekdays)
schedule:
interval: "daily"
allow:
- dependency-name: "@adobe/gatsby-theme-aio"
versioning-strategy: increase
open-pull-requests-limit: 25
labels:
- "dependencies"
ignore:
# Ignore updates to package
- dependency-name: "gatsby"
51 changes: 51 additions & 0 deletions .github/linters/.markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
###########################
###########################
## Markdown Linter rules ##
###########################
###########################

# Linter rules doc:
# - https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
#
# Note:
# To comment out a single error:
# <!-- markdownlint-disable -->
# any violations you want
# <!-- markdownlint-restore -->
#

# Default state for all rules
default: false

#################
# Rules by tags #
#################
blanks-around-fences: true # Fenced code blocks should be surrounded by blank lines
blanks-around-headings: true # Headings should be surrounded by blank lines
blanks-around-lists: true # Lists should be surrounded by blank lines
code-block-style:
style: "fenced"
code-fence-style:
style: "backtick"
emphasis-style:
style: "consistent"
fenced-code-language: true # Fenced code blocks should have a language specified
heading-start-left: true # Headings must start at the beginning of the line
heading-style:
style: "atx"
hr-style: true # Horizontal rule style
list-indent: true # Inconsistent indentation for list items at the same level
no-empty-links: true
no-missing-space-atx: true # No space after hash on atx style heading
no-multiple-blanks: true # Multiple consecutive blank lines
no-reversed-links: true
no-space-in-code: true
no-space-in-emphasis: true
no-space-in-links: true
no-trailing-spaces: true
single-trailing-newline: true # Files should end with a single newline character
strong-style:
style: "consistent"
ul-style:
style: "consistent"
Loading

0 comments on commit e305902

Please sign in to comment.