Skip to content
New issue

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

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

Already on GitHub? # to your account

"Improve this doc" links are missing #319

Open
bart-vmware opened this issue Mar 1, 2024 · 1 comment
Open

"Improve this doc" links are missing #319

bart-vmware opened this issue Mar 1, 2024 · 1 comment
Labels

Comments

@bart-vmware
Copy link
Member

The docfx links for "Improve this doc" (pointing to a GitHub source) are missing.

I suspect because of such lines in the cibuild output:

#12 2.179 [24-03-01 09:07:08.212]Info:[BuildCore.Build Document.Load.ConceptualDocumentProcessor](articles/***-basics-in-7-minutes.md)For git repo </docs>, using commit id b00b166d5da2231dadab34f1c8a89d88ac8f1af3 as the branch name.

To fix this, the DOCFX_SOURCE_BRANCH_NAME environment variable needs to be set.

For example, in a GitHub Actions workflow step:

env:
  DOCFX_SOURCE_BRANCH_NAME: ${{ github.base_ref || github.ref_name }}
@bart-vmware
Copy link
Member Author

The workflow step was updated in #315, but the "Improve this doc" links are still missing.

TimHess added a commit that referenced this issue Mar 1, 2024
* drop workflow_run trigger that seems to cause extra build runs
* use docfx:2.59.4, document that main site needs to be started separate from docs site
* move to a single gha workflow & use docker args so we can build whole image stack in a PR
* "Improve this doc" links are missing #319

---------

Co-authored-by: Bart Koelman <104792814+bart-vmware@users.noreply.github.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant