Skip to content

Commit 0b575b0

Browse files
shati-patelshati-patel
authored
Merge branch 'main' into rebase-and-merge-link-fix
2 parents e2e3fac + d0b17b7 commit 0b575b0

176 files changed

Lines changed: 1294 additions & 895 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/allowed-actions.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module.exports = [
1212
'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2
1313
'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
1414
'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
15-
'crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120',
15+
'crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c',
1616
'cschleiden/actions-linter@43fd4e08e52ed40c0e2782dc2425694388851576',
1717
'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
1818
'docker://chinthakagodawita/autoupdate-action:v1',

‎.github/workflows/link-check-dotcom.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: 'Link Checker: Dotcom'
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
7+
jobs:
8+
see_if_should_skip:
9+
continue-on-error: true
10+
runs-on: ubuntu-latest
11+
# Map a step output to a job output
12+
outputs:
13+
should_skip: ${{ steps.skip_check.outputs.should_skip }}
14+
steps:
15+
- id: skip_check
16+
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
17+
with:
18+
cancel_others: 'false'
19+
github_token: ${{ github.token }}
20+
paths: '[".github/workflows/link-check-dotcom.yml", "assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
21+
build:
22+
needs: see_if_should_skip
23+
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
24+
steps:
25+
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
26+
# Even if if doesn't do anything
27+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
28+
name: Checkout
29+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
30+
31+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
32+
name: Setup node
33+
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
34+
with:
35+
node-version: 14.x
36+
37+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
38+
name: Install
39+
run: npm ci
40+
41+
## TODO
42+
# - if: ${{ github.repository == 'github/docs-internal' && needs.see_if_should_skip.outputs.should_skip != 'true' }}
43+
# name: Clone early access
44+
# run: npm run heroku-postbuild
45+
# env:
46+
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
47+
# GIT_BRANCH: ${{ github.ref }}
48+
49+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
50+
name: Build
51+
run: npm run build
52+
53+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
54+
name: 'Link check: Dotcom'
55+
env:
56+
DOCS_VERSION: 'dotcom'
57+
run: npm run link-check

.github/workflows/link-check-test.yml renamed to .github/workflows/link-check-ghae.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Link Checker
1+
name: 'Link Checker: GitHub AE'
22

33
on:
44
workflow_dispatch:
@@ -17,7 +17,7 @@ jobs:
1717
with:
1818
cancel_others: 'false'
1919
github_token: ${{ github.token }}
20-
paths: '[".github/workflows/link-check-test.yml", "assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
20+
paths: '[".github/workflows/link-check-ghae.yml", "assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
2121
build:
2222
needs: see_if_should_skip
2323
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
@@ -51,5 +51,7 @@ jobs:
5151
run: npm run build
5252

5353
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
54-
name: Link check
54+
name: 'Link check: GitHub AE'
55+
env:
56+
DOCS_VERSION: 'github-ae'
5557
run: npm run link-check

‎.github/workflows/link-check-ghes.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: 'Link Checker: Enterprise Server'
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
7+
jobs:
8+
see_if_should_skip:
9+
continue-on-error: true
10+
runs-on: ubuntu-latest
11+
# Map a step output to a job output
12+
outputs:
13+
should_skip: ${{ steps.skip_check.outputs.should_skip }}
14+
steps:
15+
- id: skip_check
16+
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
17+
with:
18+
cancel_others: 'false'
19+
github_token: ${{ github.token }}
20+
paths: '[".github/workflows/link-check-ghes.yml", "assets/**", "content/**", "data/**", "includes/**", "javascripts/**", "jest-puppeteer.config.js", "jest.config.js", "layouts/**", "lib/**", "middleware/**", "package-lock.json", "package.json", "server.js", "translations/**", "webpack.config.js"]'
21+
build:
22+
needs: see_if_should_skip
23+
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
24+
steps:
25+
# Each of these ifs needs to be repeated at each step to make sure the required check still runs
26+
# Even if if doesn't do anything
27+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
28+
name: Checkout
29+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
30+
31+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
32+
name: Setup node
33+
uses: actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e
34+
with:
35+
node-version: 14.x
36+
37+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
38+
name: Install
39+
run: npm ci
40+
41+
## TODO
42+
# - if: ${{ github.repository == 'github/docs-internal' && needs.see_if_should_skip.outputs.should_skip != 'true' }}
43+
# name: Clone early access
44+
# run: npm run heroku-postbuild
45+
# env:
46+
# DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
47+
# GIT_BRANCH: ${{ github.ref }}
48+
49+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
50+
name: Build
51+
run: npm run build
52+
53+
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
54+
name: 'Link check: Enterprise Server'
55+
env:
56+
DOCS_VERSION: 'enterprise-server'
57+
run: npm run link-check

‎.github/workflows/site-policy-sync.yml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,14 @@ jobs:
2929

3030
# Pushes to other repo
3131
- name: Push folder to another repository
32-
uses: crykn/copy_folder_to_another_repo_action@abc264e1c16eb3d7b1f7763bfdb0e1699ad43120
32+
uses: crykn/copy_folder_to_another_repo_action@0282e8b9fef06de92ddcae9fe6cb44df6226646c
3333
env:
3434
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_SITEPOLICY }}
3535
with:
3636
source_folder: 'content/github/site-policy'
3737
destination_repo: 'github/site-policy'
38-
destination_branch: 'repo-sync'
38+
destination_branch: 'main'
39+
destination_branch_create: 'repo-sync'
3940
destination_folder: 'Policies'
4041
user_email: 'pcihon@users.noreply.github.com'
4142
user_name: 'pcihon'

‎.github/workflows/test-translations.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
name: Node.js Tests - Translations
44

55
on:
6+
workflow_dispatch:
67
schedule:
78
- cron: '10 20 * * *' # once a day at 20:10 UTC / 12:10 PST
89

@@ -75,6 +76,9 @@ jobs:
7576
- name: Install dependencies
7677
run: npm ci
7778

79+
- name: Run build script
80+
run: npm run build
81+
7882
- name: Run tests
7983
run: npx jest tests/${{ matrix.test-group }}/
8084
env:

‎assets/images/marketplace/apps-with-verified-publisher-badge.png‎

25.1 KB
Loading

‎assets/images/marketplace/publisher-verification-checklist.png‎

-2.16 KB
Loading

‎content/README.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
2121
- [`miniTocMaxHeadingLevel`](#minitocmaxheadinglevel)
2222
- [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename)
2323
- [`defaultPlatform`](#defaultplatform)
24+
- [`learningTracks`](#learningTracks)
25+
- [`includeGuides`](#includeGuides)
26+
- [`type`](#type)
27+
- [`topics`](#topics)
2428
- [Escaping single quotes](#escaping-single-quotes)
2529
- [Autogenerated mini TOCs](#autogenerated-mini-tocs)
2630
- [Versioning](#versioning)
@@ -29,6 +33,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
2933
- [Whitespace control](#whitespace-control)
3034
- [Links and image paths](#links-and-image-paths)
3135
- [Preventing transformations](#preventing-transformations)
36+
- [Creating new sublanding pages](#creating-new-sublanding-pages)
3237

3338
## Frontmatter
3439

@@ -186,6 +191,39 @@ Example:
186191
defaultPlatform: linux
187192
```
188193

194+
### `learningTracks`
195+
- Purpose: Render a list of learning tracks on a product's sub-landing page.
196+
- type: `String`. This should reference learning tracks' names defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
197+
- Optional
198+
199+
**Note: the first learning track is by-default the featured track.*
200+
201+
### `includeGuides`
202+
- Purpose: Render a list of articles, filterable by `type` and `topics`. Only applicable when used with `layout: product-sublanding`.
203+
- Type: `Array`
204+
- Optional.
205+
206+
Example:
207+
208+
```yml
209+
includeGuides:
210+
- /actions/guides/about-continuous-integration
211+
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
212+
- /actions/guides/building-and-testing-nodejs
213+
- /actions/guides/building-and-testing-powershell
214+
```
215+
216+
### `type`
217+
- Purpose: Indicate the type of article.
218+
- Type: `String`, one of the `overview`, `quick_start`, `tutorial`, `how_to`, `reference`.
219+
- Optional.
220+
221+
### `topics`
222+
- Purpose: Indicate the topics covered by the article.
223+
- Type: `String`
224+
- Optional.
225+
226+
189227
### Escaping single quotes
190228

191229
If you see two single quotes in a row (`''`) in YML frontmatter where you might expect to see one (`'`), this is the YML-preferred way to escape a single quote. From [the YAML spec](https://yaml.org/spec/history/2001-12-10.html):
@@ -274,3 +312,15 @@ Sometimes you want to link to a Dotcom-only article in Enterprise content and yo
274312
```
275313

276314
Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-sites.json`](/lib/redirects/external-sites.json) get rewritten. See [`contributing/redirects.md`](/contributing/redirects.md) for more info about this type of redirect.
315+
316+
317+
### Creating new sublanding pages
318+
319+
To create a sublanding page (e.g. [Actions' Guide page](https://docs.github.com/en/actions/guides)), create or modify an existing markdown file with these specific frontmatter values:
320+
321+
1. Use the sublanding page template by referencing it `layout: product-sublanding`
322+
2. (optional) Include the learning tracks in [`learningTracks`](#learningTracks)
323+
3. (optional) Define which articles to include with [`includeGuides`](#includeGuides).
324+
325+
If using learning tracks, they need to be defined in [`data/learning-tracks/*.yml`](../data/learning-tracks/README.md).
326+
If using `includeGuides`, make sure each of the articles in this list has [`topics`](#topics) and [`type`](#type) in its frontmatter.

‎content/actions/creating-actions/about-actions.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ versions:
1111
free-pro-team: '*'
1212
enterprise-server: '>=2.22'
1313
type: 'overview'
14+
topics:
15+
- 'Action development'
16+
- 'Fundamentals'
1417
---
1518

1619
{% data reusables.actions.enterprise-beta %}

0 commit comments

Comments
 (0)