Skip to content

Commit

Permalink
Upgrade to docfx 3
Browse files Browse the repository at this point in the history
  • Loading branch information
yufeih committed Jan 22, 2022
1 parent d7a6b9f commit 2874f54
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 50 deletions.
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: unbuntu-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

- name: run .\docfx.cmd
shell: cmd
run: .\docfx.cmd
- name: run docfx
run: docfx build --dry-run

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

This file was deleted.

31 changes: 5 additions & 26 deletions docfx.json
Original file line number Diff line number Diff line change
@@ -1,29 +1,8 @@
{
"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",
"warningsAsErrors": true,
"rules": {
"liquid-not-found": "off",
"link-out-of-scope": "off"
}
}
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.

0 comments on commit 2874f54

Please sign in to comment.