Skip to content

Commit e1265bd

Browse files
st3phhaysst3phhays
committed
(#996) Convert docs to astro
This converts all of the previous files that were being generated by Statiq into Astro framework. Now, all documentation is written in .mdx files which are located in the `src/content` folders. The README.md has been updated to reflect all of these changes and new processes.
1 parent 8d9e324 commit e1265bd

File tree

1,030 files changed

+69951
-3533
lines changed

Some content is hidden

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

1,030 files changed

+69951
-3533
lines changed

‎.devcontainer/devcontainer.json

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
2+
// https://github.com/withastro/astro/blob/main/.devcontainer/with-mdx/devcontainer.json
3+
{
4+
"name": "Node.js & TypeScript",
5+
"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bullseye",
6+
"forwardPorts": [5086],
7+
"portsAttributes": {
8+
"5086": {
9+
"label": "Astro",
10+
"onAutoForward": "openBrowser"
11+
}
12+
},
13+
"postAttachCommand": "yarn dev",
14+
"customizations": {
15+
"codespaces": {
16+
"openFiles": ["README.md"]
17+
},
18+
"vscode": {
19+
"extensions": [
20+
"DavidAnson.vscode-markdownlint",
21+
"shardulm94.trailing-spaces",
22+
"nhoizey.gremlins",
23+
"streetsidesoftware.code-spell-checker",
24+
"bierner.emojisense",
25+
"astro-build.astro-vscode",
26+
"esbenp.prettier-vscode",
27+
"unifiedjs.vscode-mdx",
28+
"ms-vscode.vscode-typescript-next",
29+
"dbaeumer.vscode-eslint"
30+
]
31+
}
32+
},
33+
"remoteUser": "node"
34+
}

‎.dockerignore

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# build output
2+
dist/
3+
4+
# generated types
5+
.astro/
6+
7+
# dependencies
8+
node_modules/
9+
10+
# git history
11+
.git
12+
13+
# logs
14+
npm-debug.log*
15+
yarn-debug.log*
16+
yarn-error.log*
17+
pnpm-debug.log*
18+
19+
# npm
20+
npm-debug.log
21+
.coverage
22+
.coverage.*
23+
.env
24+
.aws
25+
26+
# yarn
27+
.pnp.*
28+
.yarn/*
29+
!.yarn/patches
30+
!.yarn/plugins
31+
!.yarn/releases
32+
!.yarn/sdks
33+
!.yarn/versions
34+
35+
# environment variables
36+
.env
37+
.env.production
38+
39+
# macOS-specific files
40+
.DS_Store
41+
42+
# jetbrains setting folder
43+
.idea/
44+
45+
# choco-theme
46+
public/fonts
47+
public/scripts
48+
public/styles
49+
public/images/global-shared
50+
51+
# general
52+
apple-touch-*.png
53+
favicon.ico
54+
.astro

‎.editorconfig

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
insert_final_newline = true
6+
7+
[*.{js,json,yml}]
8+
charset = utf-8
9+
indent_style = space
10+
indent_size = 4

‎.gitattributes

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/.yarn/** linguist-vendored
2+
/.yarn/releases/* binary
3+
/.yarn/plugins/**/* binary
4+
/.pnp.* binary linguist-generated

‎.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Ask A Question
4+
url: https://github.com/chocolatey/docs/discussions
5+
about: Please ask and answer questions here.

‎.github/ISSUE_TEMPLATE/zFeatureRequest.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Documentation Enhancement / Addition
3+
about: Would you like to see new or updated documentation?
4+
---
5+
6+
<!--
7+
Ensure you have read over [Submitting Issues](https://github.com/chocolatey/.github/blob/main/SUBMITTING_ISSUES.md)
8+
Please check to see if your issue already exists with a quick search of the issues. Start with one relevant term and then add if you get too many results.
9+
NOTE: Keep in mind we have a [Code Of Conduct](https://github.com/chocolatey/.github/blob/main/CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community.
10+
Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in the release notes to what it is.
11+
When writing out the issue details please ensure you are writing it as if you were explaining it to somebody else.
12+
Even if you will be working on and resolving the issue yourself. This helps others to understand the reasons for the issue and for it to be searchable in future.
13+
Please do not remove any of the headings.
14+
If a heading is not applicable then enter N/A: Why it's not applicable
15+
Please remove all comments before submitting.
16+
-->
17+
18+
## What New Or Updated Would You Like To See?
19+
20+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
21+
22+
## Why Is It Needed?
23+
24+
<!-- A clear and concise description of what you want to happen. -->
25+
26+
## Additional Context?
27+
28+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/zReportIssue.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Report Issue
3+
about: Did you find issues in our documentation?
4+
---
5+
6+
<!--
7+
Ensure you have read over [Submitting Issues](https://github.com/chocolatey/.github/blob/main/SUBMITTING-ISSUES.md)
8+
9+
Please check to see if your issue already exists with a quick search of the issues. Start with one relevant term and then add if you get too many results.
10+
11+
NOTE: Keep in mind we have a [Code Of Conduct](https://github.com/chocolatey/.github/blob/main/CODE_OF_CONDUCT.md) that we expect folks to observe when they are looking for support in the Chocolatey community.
12+
13+
Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in the release notes to what it is.
14+
15+
When writing out the issue details please ensure you are writing it as if you were explaining it to somebody else.
16+
Even if you will be working on and resolving the issue yourself. This helps others to understand the reasons for the issue and for it to be searchable in future.
17+
-->
18+
19+
### What You Are Seeing?
20+
21+
22+
### What is Expected?
23+
24+
25+
### How Did You Get This To Happen? (Steps to Reproduce)
26+
27+
<!--
28+
This section is not intended to be used for suggesting documentation changes.
29+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!--
2+
BEFORE YOU CREATE A PULL REQUEST:
3+
4+
Ensure you have read over [CONTRIBUTING.md](./CONTRIBUTING.md). We provide VERY defined guidance (as such, we strongly adhere to it).
5+
6+
A summary of our expectations:
7+
- You are not submitting a pull request from your MASTER / MAIN branch.
8+
- YOUR GIT COMMIT MESSAGE FORMAT IS EXTREMELY IMPORTANT. We have a very defined expectation for this format and are sticklers about it. Really, READ the entire Contributing document. It will save you and us pain.
9+
- Do not reformat code, it makes it hard to see what has changed. Leave the formatting to us.
10+
11+
THANKS! We appreciate you reading the entire Contributing document and not just scanning through it.
12+
13+
Name your issue appropriately: give it a sentence that reads well enough for anyone seeing this in release notes to know what the issue is.
14+
15+
When writing out the pull request details please ensure you are writing it as
16+
if you were explaining it to somebody else.
17+
Even if you will be working on and resolving the issue yourself.
18+
This helps others to understand the reasons for the pull request and for it to be searchable in future.
19+
20+
Please do not remove any of the headings.
21+
If a heading is not applicable then enter N/A: Why it's not applicable
22+
23+
Make sure you have raised an issue for this pull request before continuing.
24+
25+
Please remove all comments before submitting.
26+
-->
27+
28+
## Description Of Changes
29+
<!-- Enter a description of the pull request changes -->
30+
31+
## Motivation and Context
32+
<!-- Why is this change necessary and under what context is it being done -->
33+
34+
## Testing
35+
36+
* [ ] I have previewed these changes using the [Docker Container](https://github.com/chocolatey/docs/tree/master/.devcontainer) or another method before submitting this pull request.
37+
38+
## Change Types Made
39+
<!-- Tick the boxes for the type of changes that have been made -->
40+
41+
* [ ] Minor documentation fix (typos etc.).
42+
* [ ] Major documentation change (refactoring, reformatting or adding documentation to existing page).
43+
* [ ] New documentation page added.
44+
* [ ] The change I have made should have a video added, and I have raised an issue for this.
45+
* Issue #
46+
47+
## Change Checklist
48+
49+
* [ ] Requires a change to menu structure (top or left-hand side)/
50+
* [ ] Menu structure has been updated
51+
52+
## Related Issue
53+
<!-- Make sure you have raised an issue for this pull request before continuing. -->
54+
55+
Fixes #
56+
57+
<!-- PLEASE REMOVE ALL COMMENTS BEFORE SUBMITTING -->

‎.github/labels.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
- name: "Video"
2+
color: "D0E64E"
3+
description: "The issue or PR requires a video to be recorded and included in a later PR."

‎.github/workflows/label-sync.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Sync labels
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
# Run at the end of the day (most likely UTC)
6+
- cron: "0 0 * * *"
7+
push:
8+
branches:
9+
- "master"
10+
paths:
11+
- ".github/labels.yml"
12+
13+
jobs:
14+
labels:
15+
# We use ubuntu as the image, as it is typically faster and cheaper (on private repos).
16+
runs-on: ubuntu-latest
17+
18+
steps:
19+
- uses: actions/checkout@v3.0.2
20+
- uses: EndBug/label-sync@v2.2.0
21+
with:
22+
config-file: |
23+
https://raw.githubusercontent.com/chocolatey/.github/master/.github/labels.yml
24+
.github/labels.yml
25+
request-token: ${{ secrets.SYNC_TOKEN }} # Used when getting the config files.
26+
delete-other-labels: true
27+
dry-run: false
28+
token: ${{ secrets.SYNC_TOKEN }} # Used when updating the lables on the repository

‎.github/workflows/playwright.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Playwright Tests
2+
3+
on:
4+
pull_request:
5+
branches: [ main, master ]
6+
workflow_dispatch:
7+
jobs:
8+
test:
9+
timeout-minutes: 60
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout repository using git
13+
uses: actions/checkout@v4
14+
- name: Setup Node.js
15+
uses: actions/setup-node@v4
16+
with:
17+
node-version: '20'
18+
- name: Build site
19+
run: yarn build
20+
- name: Run Playwright tests
21+
run: yarn playwright
22+
- uses: actions/upload-artifact@v4
23+
if: always()
24+
with:
25+
name: playwright-report
26+
path: playwright-report/
27+
retention-days: 14

‎.github/workflows/publish.yaml

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Publish Documentation
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
workflow_dispatch:
7+
8+
# Allow this job to clone the repo and create a page deployment
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository using git
19+
uses: actions/checkout@v4
20+
- name: Install, build, and upload site
21+
uses: withastro/action@v2
22+
23+
deploy:
24+
needs: build
25+
runs-on: ubuntu-latest
26+
environment:
27+
name: github-pages
28+
url: ${{ steps.deployment.outputs.page_url }}
29+
steps:
30+
- name: Deploy to GitHub Pages
31+
id: deployment
32+
uses: actions/deploy-pages@v4

‎.gitignore

+34
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# build output
22
dist/
3+
34
# generated types
45
.astro/
56

@@ -12,6 +13,21 @@ yarn-debug.log*
1213
yarn-error.log*
1314
pnpm-debug.log*
1415

16+
# npm
17+
npm-debug.log
18+
.coverage
19+
.coverage.*
20+
.env
21+
.aws
22+
23+
# yarn
24+
.pnp.*
25+
.yarn/*
26+
!.yarn/patches
27+
!.yarn/plugins
28+
!.yarn/releases
29+
!.yarn/sdks
30+
!.yarn/versions
1531

1632
# environment variables
1733
.env
@@ -22,3 +38,21 @@ pnpm-debug.log*
2238

2339
# jetbrains setting folder
2440
.idea/
41+
42+
# choco-theme
43+
public/fonts
44+
public/scripts
45+
public/styles
46+
public/images/global-shared
47+
48+
# general
49+
apple-touch-*.png
50+
favicon.ico
51+
.astro
52+
53+
# playwright
54+
/src/tests/
55+
/test-results/
56+
/playwright-report/
57+
/blob-report/
58+
/playwright/.cache/

‎.markdownlint.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"MD026": false,
3+
"MD013": false,
4+
"MD024": false,
5+
"MD034": false,
6+
"MD033": {
7+
"allowed_elements": ["details", "strong", "summary"]
8+
}
9+
}

0 commit comments

Comments
 (0)