Skip to content

Commit fefeb4a

Browse files
viktorkombovviktorkombov
authored
Merge branch 'master' into dtsvetkov/update-charts-missing-links
2 parents 2a5113e + bb86f85 commit fefeb4a

7 files changed

Lines changed: 545 additions & 2 deletions

File tree

‎.github/CONTRIBUTING.md‎

Lines changed: 372 additions & 0 deletions
Large diffs are not rendered by default.

‎.github/ISSUE_TEMPLATE/docs-issue.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Documentation issue
2+
description: Report incorrect, missing, or outdated documentation content
3+
labels:
4+
- 'status: in-review'
5+
type: Bug
6+
body:
7+
- type: input
8+
id: topic-url
9+
attributes:
10+
label: Topic / URL
11+
description: Link to the affected documentation page or path to the MDX source file.
12+
placeholder: 'e.g. https://… or docs/xplat/src/content/en/components/grids/grid/overview.mdx'
13+
validations:
14+
required: true
15+
16+
- type: checkboxes
17+
id: platforms
18+
attributes:
19+
label: Platform(s) affected
20+
options:
21+
- label: Angular
22+
- label: React
23+
- label: WebComponents
24+
- label: Blazor
25+
- label: All platforms
26+
27+
- type: dropdown
28+
id: issue-type
29+
attributes:
30+
label: Issue type
31+
options:
32+
- Incorrect or misleading content
33+
- Missing content / feature not documented
34+
- Outdated content (API change, version update)
35+
- Broken link
36+
- Broken or missing sample
37+
- Code snippet error
38+
- Typo / grammar
39+
- Other
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: description
45+
attributes:
46+
label: Description
47+
description: Describe the problem clearly. Include the exact text, heading, or code block that is wrong where applicable.
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: expected
53+
attributes:
54+
label: Expected content
55+
description: What should the documentation say or show instead?
56+
57+
- type: textarea
58+
id: context
59+
attributes:
60+
label: Additional context
61+
description: Screenshots, related issues, API docs links, or any other context that helps reproduce or understand the issue.

‎.github/ISSUE_TEMPLATE/docs-task.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Documentation task / enhancement
2+
description: Request new documentation, a topic update, or a content improvement
3+
labels:
4+
- 'status: in-review'
5+
type: Task
6+
body:
7+
- type: checkboxes
8+
id: task-type
9+
attributes:
10+
label: Task type
11+
options:
12+
- label: New topic / component documentation
13+
- label: Update existing topic (new release, API change, new feature)
14+
- label: Add missing platform variant (Angular / React / WebComponents / Blazor)
15+
- label: Improve existing content (clarity, examples, structure)
16+
- label: Add or update code samples
17+
- label: Other
18+
19+
- type: checkboxes
20+
id: platforms
21+
attributes:
22+
label: Platform(s)
23+
options:
24+
- label: Angular
25+
- label: React
26+
- label: WebComponents
27+
- label: Blazor
28+
- label: All platforms
29+
30+
- type: textarea
31+
id: description
32+
attributes:
33+
label: Description
34+
description: >
35+
What needs to be written or changed? Be as specific as possible —
36+
include component name, feature, version, or a link to the relevant API / changelog.
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: acceptance-criteria
42+
attributes:
43+
label: Acceptance criteria
44+
description: List what "done" looks like.
45+
placeholder: |
46+
- Topic covers installation, basic usage, and configuration
47+
- All four platforms have a code sample
48+
- API References section lists the primary types
49+
- Sample is embedded and working
50+
51+
- type: textarea
52+
id: resources
53+
attributes:
54+
label: Related resources
55+
description: Links to API docs, GitHub PR/issue in the component repo, existing topic to update, design spec, etc.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Closes #
2+
3+
### Checklist:
4+
5+
- [ ] check topic's TOC/menu and paragraph headings
6+
- [ ] Include TOC topic labels in the topic content when it has a valuable update, is new, or is considered `preview` / `beta`
7+
- [ ] link to other topics using `../relative/path.md`
8+
- [ ] at the References section at the end of the topic add links to topics, samples, etc
9+
- [ ] reference API documentation instead of adding a section with API
10+
11+
<br />
12+
13+
- [ ] use valid component names - [Data] Grid, `IgxSelectComponent`, `<igx-combo>`
14+
- [ ] use spell checker tool (VS Code, Grammarly, Microsoft Editor)
15+
- [ ] add inline `code blocks` for the names of classes / tags / properties
16+
- [ ] add language descriptor for the ```code blocks```
17+
- [ ] check if links function by running the `check-api/mdx` npm commands
18+
- [ ] check if sample is working and fully visible in the topic
19+
- [ ] check if sample is working and fully visible in the StackBlitz
20+
- [ ] check if code blocks match the code in StackBlitz demo
21+
22+
23+
<br />
24+
25+
- [ ] follow SEO guidelines to fill topic's metadata ([SEO guidelines](https://infragisticsinc297.sharepoint.com/:w:/g/Groups/marketing/EWz9InT4FDlErHCumxsKGY4Bd8H03yhRWxDFk47luRz-_Q?e=S5wWcx))
26+
27+
<br />
28+
29+
- [ ] do not resolve requested changes (leave that to the reviewer)

‎.github/workflows/pr-stale.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Mark stale pull requests and issues"
2+
on:
3+
schedule:
4+
# Run every day at midnight UTC
5+
- cron: '0 0 * * *'
6+
7+
jobs:
8+
stale:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
issues: write
12+
pull-requests: write
13+
steps:
14+
- uses: actions/stale@v9 # Use the actions/stale action
15+
with:
16+
remove-pr-stale-when-updated: true
17+
days-before-stale: 30
18+
# days-before-pr-close: 7
19+
stale-issue-message: 'Auto-tagged as stale status because no activity in the last 30 days.'
20+
stale-pr-message: 'Auto-tagged as stale status because no activity in the last 30 days.'
21+
# It will be closed in 7 days if no further activity occurs. Thank you for your contributions.
22+
# close-pr-message: 'This pull request has been closed due to inactivity.'
23+
stale-pr-label: 'status: stale'
24+
stale-issue-label: 'status: stale'
25+
# exempt-pr-labels: 'keep-open, awaiting-upstream' # Labels to exempt from being marked stale
26+
# https://github.com/actions/stale - arguments reference

‎docs/angular/src/content/en/components/exporter-csv.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public exportButtonHandler() {
117117

118118
```
119119

120-
<Sample src="/services/export-csv-sample-1" height={600} alt="" />
120+
<Sample src="/services/export-csv-sample-1" height={300} alt="" />
121121

122122
## Customizing the Exported Format
123123

‎docs/angular/src/content/jp/components/exporter-csv.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public exportButtonHandler() {
117117

118118
```
119119

120-
<Sample src="/services/export-csv-sample-1" height={600} alt="" />
120+
<Sample src="/services/export-csv-sample-1" height={300} alt="" />
121121

122122
## エクスポート形式のカスタマイズ
123123

0 commit comments

Comments
 (0)