generated from AdobeDocs/dev-site-documentation-template
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c04b2cc
commit 42723b3
Showing
22 changed files
with
22,482 additions
and
25,571 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
########################################### | ||
# These are the rules used for # | ||
# linting all the yaml files in the stack # | ||
# NOTE: # | ||
# You can disable line with: # | ||
# # yamllint disable-line # | ||
########################################### | ||
rules: | ||
braces: | ||
level: warning | ||
min-spaces-inside: 0 | ||
max-spaces-inside: 0 | ||
min-spaces-inside-empty: 1 | ||
max-spaces-inside-empty: 5 | ||
brackets: | ||
level: warning | ||
min-spaces-inside: 0 | ||
max-spaces-inside: 0 | ||
min-spaces-inside-empty: 1 | ||
max-spaces-inside-empty: 5 | ||
colons: | ||
level: warning | ||
max-spaces-before: 0 | ||
max-spaces-after: 1 | ||
commas: | ||
level: warning | ||
max-spaces-before: 0 | ||
min-spaces-after: 1 | ||
max-spaces-after: 1 | ||
comments: disable | ||
comments-indentation: disable | ||
document-end: disable | ||
document-start: | ||
level: warning | ||
present: true | ||
empty-lines: | ||
level: warning | ||
max: 2 | ||
max-start: 0 | ||
max-end: 0 | ||
hyphens: | ||
level: warning | ||
max-spaces-after: 1 | ||
indentation: | ||
level: warning | ||
spaces: consistent | ||
indent-sequences: true | ||
check-multi-line-strings: false | ||
key-duplicates: enable | ||
line-length: | ||
level: warning | ||
max: 100 | ||
allow-non-breakable-words: true | ||
allow-non-breakable-inline-mappings: true | ||
new-line-at-end-of-file: disable | ||
new-lines: | ||
type: unix | ||
trailing-spaces: disable |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
// This script retrieves the pathPrefix from the gatsby-config.js file. | ||
// It serves as an example for how to set up external javascript functions | ||
// outside workflow .yml files when they get too big or complex to keep them inline. | ||
|
||
// Documentation for the actions/github-script: | ||
// https://github.com/actions/github-script#run-a-separate-file | ||
|
||
module.exports = async ({ core }) => { | ||
const { pathPrefix } = await require('../../gatsby-config.js'); | ||
|
||
if (!pathPrefix) { | ||
core.setFailed( | ||
`The pathPrefix in the site's gatsby-config.js file is missing. | ||
To fix this, open your gatsby-config.js file, and add it to the config object: | ||
module.exports = { | ||
pathPrefix: "/commerce/frontend-core/", | ||
... | ||
}` | ||
); | ||
} else if (pathPrefix === '/') { | ||
core.setFailed( | ||
`The pathPrefix in the site's gatsby-config.js file is set to "/". This is not allowed. | ||
To fix this, change the pathPrefix to include a name that starts and ends with "/": | ||
pathPrefix: "/commerce/frontend - core/" | ||
This name identifies the site within the developer.adobe.com domain: | ||
https://developer.adobe.com/document-services/<PATH_TO_FILES>. | ||
` | ||
); | ||
} else { | ||
if (!pathPrefix.startsWith('/') || !pathPrefix.endsWith('/')) { | ||
core.setFailed( | ||
`The pathPrefix in the site's gatsby-config.js file does not start or end with "/". | ||
To fix this, change the pathPrefix to include a name that starts and ends with "/". | ||
For example: "/document-services/" or "/commerce/cloud-tools/". | ||
This is required by convention because of the way we construct site URLs. | ||
For example: https://developer.adobe.com + /document-services/ + path/to/files/. | ||
` | ||
); | ||
} | ||
} | ||
core.setOutput('path_prefix', pathPrefix); | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
IGNORE_GITIGNORED_FILES=true | ||
VALIDATE_GITLEAKS=true | ||
VALIDATE_MARKDOWN=true | ||
MARKDOWN_CONFIG_FILE=.markdownlint.yml | ||
VALIDATE_YAML=true | ||
VALIDATE_JSON=true |
Oops, something went wrong.