Skip to content

Commit 34f37d6

Browse files
vkublytskyivkublytskyi
committed
Preparation to migrate to public GitHub
1 parent c437640 commit 34f37d6

File tree

34 files changed

+2521
-1986
lines changed

34 files changed

+2521
-1986
lines changed

‎.env.example

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
REPO_GITHUB_TOKEN=
2-
REPO_OWNER=dx-devex-acceleration
3-
REPO_NAME=uix-docs
2+
REPO_OWNER=AdobeDocs
3+
REPO_NAME=uix
44
REPO_BRANCH=main

‎.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?

‎.yarn/releases/yarn-3.2.1.cjs

+786
Large diffs are not rendered by default.

‎.yarn/releases/yarn-3.2.3.cjs

-783
This file was deleted.

‎.yarnrc.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1+
---
12
nodeLinker: node-modules
2-
3-
yarnPath: .yarn/releases/yarn-3.2.3.cjs
3+
yarnPath: .yarn/releases/yarn-3.2.1.cjs

‎README.md

+33-3
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,40 @@ UI Extensibility allows to injection of 3rd-party UI implemented as App Builder
77
# Contribution
88
## Local Development
99

10-
For local development, simply use :
10+
### Prerequisites
11+
12+
This project uses Yarn 3 to manage package dependencies. If you do not have Yarn 3 installed, follow these instructions:
13+
14+
1. Install [Node.js LTS](https://nodejs.org/en/download/). At the time of writing, the latest LTS version is `v16.15.1`.
15+
2. Install Yarn 3 by running the following command:
16+
17+
```bash
18+
corepack enable
19+
```
20+
21+
Corepack is a binary shipped with all Node.js releases starting from 16.10.
22+
23+
3. Update Yarn to the latest version by running the following command:
24+
25+
```bash
26+
yarn set version stable
27+
```
28+
29+
4. Make sure you are now using version 3.2.1 of Yarn:.
30+
31+
```bash
32+
yarn --version
33+
```
34+
35+
That's it. For more information on Yarn 3 usage, see [Yarn usage](https://yarnpkg.com/getting-started/usage).
36+
37+
### Run development server
38+
39+
For local development, simply use:
40+
1141
```
12-
$ npm install
13-
TBD
42+
$ yarn install
43+
$ yarn dev
1444
```
1545
## Adobe I/O Documentation Template
1646

‎gatsby-config.js

+42-45
Original file line numberDiff line numberDiff line change
@@ -11,92 +11,89 @@
1111
*/
1212

1313
module.exports = {
14-
pathPrefix: process.env.PATH_PREFIX || "/pages/dx-devex-acceleration/uix-docs/",
14+
pathPrefix: process.env.PATH_PREFIX || "/uix/",
1515
siteMetadata: {
16-
home: {
17-
title: "UI Extensibility",
18-
path: "/"
19-
},
2016
pages: [
17+
{
18+
title: "UI Extensibility",
19+
path: "/",
20+
},
2121
{
2222
title: "Overview",
23-
path: "overview/",
23+
path: "/overview/"
2424
},
2525
{
2626
title: "Guides",
27-
path: "guides/"
27+
path: "/guides/"
2828
},
2929
{
3030
title: "Extensible Services",
3131
menu: [
3232
{
3333
title: "AEM Content Fragments Console",
34-
path: "services/aem-cf-console-admin/"
34+
path: "/services/aem-cf-console-admin/"
3535
}
3636
]
3737
}
3838
],
3939
subPages: [
4040
// Overview
41-
{
42-
title: "Overview",
43-
path: "overview/"
44-
},
45-
{
46-
title: "Why I Need It",
47-
path: "overview/reason/"
48-
},
49-
{
50-
title: "How It Works",
51-
path: "overview/design/"
52-
},
53-
{
54-
title: "How to Get Access",
55-
path: "overview/get-access/"
56-
},
57-
{
58-
title: "App Builder and UI Extensibility",
59-
path: "overview/app-builder/"
60-
},
61-
{
62-
title: "FAQ",
63-
path: "overview/faq/"
64-
},
41+
{
42+
title: "Why I Need It",
43+
path: "/overview/reason/"
44+
},
45+
{
46+
title: "How It Works",
47+
path: "/overview/design/"
48+
},
49+
{
50+
title: "How to Get Access",
51+
path: "/overview/get-access/"
52+
},
53+
{
54+
title: "App Builder and UI Extensibility",
55+
path: "/overview/app-builder/"
56+
},
57+
{
58+
title: "FAQ",
59+
path: "/overview/faq/"
60+
},
6561
// Common guides
66-
{
67-
title: "Guides Overview",
68-
path: "guides/"
69-
},
7062
{
7163
title: "UI Extensions Development Flow",
72-
path: "guides/development-flow/"
64+
path: "/guides/development-flow/"
7365
},
7466
{
7567
title: "UI Extension Publication and Management",
76-
path: "guides/publication/"
68+
path: "/guides/publication/"
7769
},
7870
{
7971
title: "Set Up Local Environment",
80-
path: "guides/local-environment/"
72+
path: "/guides/local-environment/"
8173
},
8274
// Services
75+
{
76+
title: "Extensible Services",
77+
path: "/services/",
78+
header: true
79+
},
8380
{
8481
title: "Extension Points",
85-
path: "services/aem-cf-console-admin/api/"
82+
path: "/services/aem-cf-console-admin/api/"
8683
},
8784
{
8885
title: "Step-by-step Extension Development",
89-
path: "services/aem-cf-console-admin/extension-development/"
86+
path: "/services/aem-cf-console-admin/extension-development/"
9087
},
9188
{
9289
title: "Code Generation",
93-
path: "services/aem-cf-console-admin/code-generation/"
90+
path: "/services/aem-cf-console-admin/code-generation/"
9491
},
9592
{
9693
title: "Troubleshooting",
97-
path: "services/aem-cf-console-admin/debug/"
98-
},
99-
],
94+
path: "/services/aem-cf-console-admin/debug/"
95+
}
96+
]
10097
},
10198
plugins: [
10299
"@adobe/gatsby-theme-aio/"

‎package.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,13 @@
33
"name": "@adobe/uix-docs",
44
"version": "1.0.0",
55
"license": "Apache-2.0",
6+
"repository": {
7+
"type": "git",
8+
"url": "https://github.com/AdobeDocs/uix"
9+
},
610
"dependencies": {
7-
"@adobe/gatsby-theme-aio": "^4.4.4",
8-
"gatsby": "^4.13.0",
11+
"@adobe/gatsby-theme-aio": "^4.6.6",
12+
"gatsby": "4.22.0",
913
"react": "^17.0.0",
1014
"react-dom": "^17.0.0"
1115
},

0 commit comments

Comments
 (0)