In Azure Devops, there is the possibility to view Readme.md files, but I would like to include/merge some text from another .md-file into that document. Or perhaps combine them in a wiki.
I am not able to find documentation on doing these kind of operations.
I have heard of tools like Pandoc and Sphinx, but I am not sure if Azure Devops supports that on their web app.
Markdown syntax supports include other md files [link text](file-name.md), however these files can only be rendered as links.
It seems azure devops does not support pandoc or sphinx, for I could not find any related extensions on azure devops marketplace.
There is a suggestion that you can build your README.md file using pandoc to include/merge other md files, or other methods mentioned in the thread #eskwayrd commented, before you commit to your repo.
Related
I am planning to use Azure DevOps for agile project management. I was trying out Jira / Confluence earlier. I do understand confluence is good for document management etc. In Azure DevOps, I understand there is Wiki for content management. I want to link all of my requirements, technical and other documentation currently existing as MS Word documents into ADO Wiki. I am unable to do that though - ADO Wiki allows a link of an object within ADO, but how do I get my word and other docs into ADO in the first place, and where do I put them - is there a general repository? Thanks
I am trying to find out how to link my external documents to ADO Wiki.
You could use markdown syntax to link external documents to ADO Wiki: https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops#links
Presumably your documents are not already hosted by another HTTP/Web Server. If they are then RoyWang-MSFT has your answer.
By Azure DevOps Wiki (ADO Wiki) convention each "project Wiki" is backed by a hosting git repository. Within each repository is a .attachments folder where "Insert File" (uploads/attachments) are housed. You may clone your project Wiki's repository and copy your files into this .attachments folder. Then you can use standard git commands to add, commit, and push your files. Then link to them like this [YourDocDisplayname](/.attachments/YourDoc.docx).
As part of an Azure Pipeline to build a Python package and store it in Azure Artifacts I'm generating a lot of .md files from the docstrings as documentation for the package. I'd like to add a step to my pipeline to automatically upload those to the Azure DevOps Wiki. Is this possible? From the official documentation I could only find a way to do it manually from a folder in the repo.
I ended up cloning the wiki repository and subsequently adding and committing the generated files as part of the pipeline step.
You can use Rest Api to update Wiki pages: Pages.
Here you can find a sample with PowerShell: https://github.com/ashamrai/AzureDevOpsExtensions/blob/master/CustomPSTasks/UpdateWikiPage.ps1
Our release pipeline is generating some HTML docs (currently via Doxygen) every time a PR is merged to master.
As we use Azure Dev Ops it would be nice to publish the docs there (in the Wiki perhaps?).
What is the easiest/most proper way to do that?
In azure Dev Ops you can publish a wiki from git files. See:
https://learn.microsoft.com/en-us/azure/devops/project/wiki/publish-repo-to-wiki?view=azure-devops&tabs=browser#publish-a-git-repository-to-a-wiki-1
This would require to know up front the files that will be created by doxygen so that they can be commited by your doxygen pipeline.
I was recently told by my IT department that I can't use Github as a code repository, so I'm using Azure Repos in Azure Devops.
I am primarily a designer, and my only usage for Github was to render HTML, CSS, and Javascript as a working prototype in Github Pages that can be shared to anyone with an internet connection.
I am not at all familiar with Azure DevOps or Azure Repos, is there any way to show my front end code as a generated page using Azure? Would I have to use something like Jekyll or Hugo?
Is there any way to show my front end code as a generated page using
Azure? Would I have to use something like Jekyll or Hugo?
Displaying the front-end UI directly in Azure Repos is still a not-supported scenario for now.
Azure Repos in Azure Devops Service supports Git and TFVC version control system to manage the code. But it doesn't mean it supports same functions like Github, at least Azure Repos itself doesn't have the feature to render HTML, CSS, and Javascript and display the front-end UI.
Also, I checked the Azure Devops extensions here and didn't find one extension that meet your needs. So I think what you want is now not supported for Azure Repos. You may use the Azure Repos to host the HTML, CSS, and Javascript files like what Github repos do, clone it locally and use third-party tool to display the UI when necessary.
Also, you may post a feature request with details about what you want with Azure Devops Repos here. If it gets enough votes, the team would consider it seriously! Hope all above helps :)
I want to use AsciiDoc for documentation purposes and check the documentation into the Git repository next to the code. The AsciiDoc source files I want to be compiled to PDF during build and to be part of the build artifacts. Is there a plugin for VSTS, or a best practise for an on-premise windows build agent?
For Now, AsciiDoc is not supported for VSTS.
But there has related user voices suggest this feature, like Add Preview for AsciiDoc (.adoc) files in addition to Markdown and Add support for asciidoc, particular for README.adoc like github has. And you can vote and follow up the user voices.
Another link to the idea page.