Skip to content

Commit

Permalink
TocDocFxCreation was renamed to DocFxTocGenerator. Added DocFx Quick …
Browse files Browse the repository at this point in the history
…Start to replace Validation pipeline and Build pipeline samples. Contains more and better guidance. (#7866)

Co-authored-by: Martin Tirion <[email protected]>
  • Loading branch information
mtirionMSFT and mtirion authored Jan 28, 2022
1 parent 2c6f6e6 commit d51b623
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 20 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
34 changes: 14 additions & 20 deletions Documentation/templates-and-plugins/tools-dashboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@ title: 'Available tools'
documentType: dashboard
contributionLink: ~/templates-and-plugins/contribute-your-template.md
items:
- name: TocDocFxCreation
description: Generate a Table of Contents (TOC) in YAML format for DocFX. It has features like the ability to configure the order of files and the names of documents and folders.
- name: DocFxTocGenerator
description: Generate a Table of Contents (TOC) in YAML format for DocFX. It has features like the ability to configure the order of files and the names of documents and folders. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.
type: External
thumbnail: ~/templates-and-plugins/images/tocdocfxgenerator.screenshot.png
thumbnail: ~/templates-and-plugins/images/docfstocgenerator.screenshot.png
homepage: https://github.com/Ellerbach/docfx-companion-tools
repository:
type: git
url: "https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/TocDocFxCreation"
url: "https://github.com/Ellerbach/docfx-companion-tools/tree/main/src/DocFxTocGenerator"
license: MIT
usage:
install: "choco install docfx-companion-tools"
init: "git clone https://github.com/Ellerbach/docfx-companion-tools.git"
command: "TocGenerator -d <docs folder> [-o <output folder>] [-vsi]"
- name: DocLinkChecker
description: Validate links in documents and check for orphaned attachments in the .attachments folder. The tool indicates whether there are errors or warnings, so it can be used in a CI pipeline. It can also clean up orphaned attachments automatically.
description: Validate links in documents and check for orphaned attachments in the .attachments folder. The tool indicates whether there are errors or warnings, so it can be used in a CI pipeline. It can also clean up orphaned attachments automatically. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.
type: External
thumbnail: ~/templates-and-plugins/images/doclinkchecker.screenshot.png
homepage: https://github.com/Ellerbach/docfx-companion-tools
Expand All @@ -30,7 +31,7 @@ items:
init: "git clone https://github.com/Ellerbach/docfx-companion-tools.git"
command: "DocLinkChecker -d <docs folder> [-vac]"
- name: DocLanguageTranslator
description: Allows to generate and translate automatically missing files or identify missing files in multi language pattern directories.
description: Allows to generate and translate automatically missing files or identify missing files in multi language pattern directories. This tool is part of the DocFx Companion Tools set that can be installed using Chocolatey.
type: External
thumbnail: ~/templates-and-plugins/images/doclanguagetranslator.screenshot.png
homepage: https://github.com/Ellerbach/docfx-companion-tools
Expand All @@ -41,24 +42,17 @@ items:
usage:
init: "git clone https://github.com/Ellerbach/docfx-companion-tools.git"
command: "DocLanguageTranslator -d <docs folder> [-k <key>] [-l <location>] [-cv]"
- name: Validation pipeline example
description: A sample pipeline to use markdownlint to validate markdown style and the DocLinkChecker to validate the links and attachments.
- name: DocFx Quick Start
description: A repo containing documentation, configuration and sample pipelines to help you get started quickly with DocFx. The Quick Start can be used as a reference or to copy elements from it to your own repo. The Quick Start itself can be generated to a website using DocFx as well. It uses the DocFx Companion Tools *DocFxTocGenerator* and *DocLinkChecker*.
type: External
thumbnail: ~/templates-and-plugins/images/pipeline-validation.screenshot.png
homepage: https://github.com/Ellerbach/docfx-companion-tools
thumbnail: ~/templates-and-plugins/images/docfxquickstart.screenshot.png
homepage: https://github.com/mtirionMSFT/DocFxQuickStart
repository:
type: git
url: "https://github.com/Ellerbach/docfx-companion-tools/blob/main/PipelineExamples/documentation-validation.yml"
license: MIT
- name: Build pipeline example
description: A sample pipeline to use the TocDocFxCreation for generating the table of contents and DocFx to generate a website. This sample will also publish to an Azure App Service.
type: External
thumbnail: ~/templates-and-plugins/images/pipeline-build.screenshot.png
homepage: https://github.com/Ellerbach/docfx-companion-tools
repository:
type: git
url: "https://github.com/Ellerbach/docfx-companion-tools/blob/main/PipelineExamples/documentation-build.yml"
url: "https://github.com/mtirionMSFT/DocFxQuickStart"
license: MIT
usage:
init: "git clone https://github.com/mtirionMSFT/DocFxQuickStart.git"
- name: Addin for Cake Build System
description: Cake AddIn that generates documentation for .Net API reference and markdown files using DocFx.
type: External
Expand Down

0 comments on commit d51b623

Please sign in to comment.