Skip to content

Commit 7713212

Browse files
committed
Add source URL comments to website assets
This will make it easier for the maintainers to sync fixes and improvements in either direction between the upstream "template" assets and their installations in this repository.
1 parent 82cfc78 commit 7713212

File tree

6 files changed

+9
-0
lines changed

6 files changed

+9
-0
lines changed

.github/workflows/check-mkdocs-task.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-mkdocs-task.md
12
name: Check Website
23

34
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/deploy-cobra-mkdocs-versioned-poetry.md
12
name: Deploy Website
23

34
on:

Taskfile.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,13 +226,15 @@ tasks:
226226
cmds:
227227
- poetry run black .
228228

229+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-cobra-mkdocs-versioned-poetry/Taskfile.yml
229230
docs:generate:
230231
desc: Create all generated documentation content
231232
deps:
232233
- task: go:cli-docs
233234
# Make the formatting consistent with the non-generated Markdown
234235
- task: general:format-prettier
235236

237+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/deploy-cobra-mkdocs-versioned-poetry/Taskfile.yml
236238
go:cli-docs:
237239
desc: Generate command line interface reference documentation
238240
dir: ./docsgen
@@ -242,6 +244,7 @@ tasks:
242244
# The binary is invoked like this instead of `./{{.PROJECT_NAME}}` to remove the `./` chars from the examples
243245
- PATH=. {{.PROJECT_NAME}} ../docs/commands
244246

247+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
245248
website:check:
246249
desc: Check whether the MkDocs-based website will build
247250
deps:
@@ -250,6 +253,7 @@ tasks:
250253
cmds:
251254
- poetry run mkdocs build --strict
252255

256+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/check-mkdocs-task/Taskfile.yml
253257
website:serve:
254258
desc: Run website locally
255259
deps:

docsgen/go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/cobra/docsgen/go.mod
12
module github.com/arduino/arduino-lint/docsgen
23

34
go 1.16

docsgen/main.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/cobra/docsgen/main.go
12
//
23
// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
34
//

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/mkdocs/mkdocs.yml
12
# See: https://www.mkdocs.org/user-guide/configuration/
23
site_name: Arduino Lint
34
site_description: Tool to check for problems with Arduino projects

0 commit comments

Comments
 (0)