Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docfx sanity check #2285

Merged
merged 14 commits into from
Mar 24, 2022
12 changes: 7 additions & 5 deletions .github/workflows/checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -61,17 +61,19 @@ jobs:
run: make misspell

docfx:
runs-on: windows-latest
runs-on: ubuntu-latest
steps:
- name: check out code
uses: actions/checkout@v2

- name: install docfx
run: choco install docfx -y
uses: actions/setup-dotnet@v1
with:
dotnet-version: 6.0.x
run: dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json
yufeih marked this conversation as resolved.
Show resolved Hide resolved
arminru marked this conversation as resolved.
Show resolved Hide resolved

- name: run .\docfx.cmd
shell: cmd
run: .\docfx.cmd
- name: run docfx
run: docfx build --dry-run
yufeih marked this conversation as resolved.
Show resolved Hide resolved

semantic-conventions:
runs-on: ubuntu-latest
Expand Down
15 changes: 0 additions & 15 deletions docfx.cmd

This file was deleted.

30 changes: 3 additions & 27 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -1,29 +1,5 @@
{
"build": {
"content": [
{
"files": [
"**.md",
"toc.yml"
]
}
],
"resource": [
{
"files": [
".github/CODEOWNERS",
".markdownlint.yaml",
".vscode/settings.json",
"**.png"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": true,
"disableGitFeatures": true
}
"files": "**/*.{md,png}",
"exclude": "*",
"warningsAsErrors": true
}
2 changes: 1 addition & 1 deletion specification/compatibility/opentracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ OpenTracing defines two types of references:

OpenTelemetry does not define strict equivalent semantics for these
references. These reference types must not be confused with the
[Link](../trace/api.md##specifying-links) functionality. This information
[Link](../trace/api.md#specifying-links) functionality. This information
is however preserved as the `opentracing.ref_type` attribute.

## In process Propagation exceptions
Expand Down
2 changes: 1 addition & 1 deletion specification/metrics/supplementary-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ to record the total number of bytes received:
You can see that the total increment during (T<sub>0</sub>, T<sub>1</sub>] is
`0`, the total increment during (T<sub>1</sub>, T<sub>2</sub>] is `280` (`30 +
200 + 50`), the total increment during (T<sub>2</sub>, T<sub>3</sub>] is `100`,
and the total increment during (T<s3ub>0</sub>, T<sub>3</sub>] is `380` (`0 +
and the total increment during (T<sub>0</sub>, T<sub>3</sub>] is `380` (`0 +
280 + 100`). All the increments are non-negative, in other words, the **sum is
monotonically increasing**.

Expand Down
2 changes: 0 additions & 2 deletions toc.yml

This file was deleted.