Repository navigation
Doc for --disableGitFeatures doesn't explain what the "git features" are #5732
Description
Operation System: Windows
DocFX Version Used: 2.51.0 (NuGet)
Template used: default
Steps to Reproduce:
- Run docfx on a git repository
Expected Behavior:
Documentation explains what the "git features" are, so user can know whether having them enabled is of interest or not.
Actual Behavior:
Documentation simply says --disableGitFeatures is to "Disable fetching Git related information for articles", and user doesn't know what features they are losing by using that flag.
Incidentally, running with:
docfx.exe docfx.json --intermediateFolder ..\build\docs\obj -o ..\build\docs --cleanupCacheHistory --debugOutput --debug --disableGitFeaturesI still can hit some git error:
Skipping GetFileDetail. Exception found: Microsoft.DocAsCode.Common.Git.GitException, Message:
[...] can't find remote branch in this repo and fallback to use local branch [master]: fatal: no upstream configured for branch 'master'Reacted by RS
Activity
QFSW commentedon Apr 7, 2020
My understanding was that git features allows you to jump to source code from API reference, but that may be incorrect/incomplete (so you're definitely right the documentation needs improving)
KalleOlaviNiemitalo commentedon Apr 8, 2020
In DocFX v2.50, the
disableGitFeaturesflag is checked (as opposed to being propagated) only by GitUtility.TryGetFileDetail, which collects the remote repository URL and branch name. The template then generates the URL for the "Improve this Doc" link from those.In DocFX v3, there is instead code to get the GitHub login names of people who contributed to the documentation. Which can't work if the repository is hosted elsewhere.