Working on a relatively new team in a much larger organization, and as a side project I am looking at our current documentation for opportunities to improve/standardize our best practices/standards. The ideal tool we would like to use, if up to the task, is Azure DevOps Wiki (this is AZDO Service, not Server) since it lines up with the rest of our PM functions. I was doing some digging, and I have not found much in the way of resources/templates/guides that can really get you going for Azure DevOps Wiki.
Beyond general documentation best practices, is there any helpful tricks/resources that we can use to make the most out of that particular tool? Or is there just a better tool we should consider? Looking for ideas! Any feedback is appreciated.
What I am looking for is a library of templates/resources that could
be used to help standardize documentation.
Official doesn't provided any template or resources for standard. There has been a feature request here:
Make it possible to create wiki page based on a template
You can upvote this feature request of Azure DevOps and share your ideas.
But since the DevOps wiki is designed based on Azure DevOps repository, you can clone the template you want to your wiki repository.
The repository url of your wiki should be:
https://dev.azure.com/<Organization Name>/<Project Name>/_git/<Project Name>.wiki
Use this command to clone the wiki repository:
git clone https://<Personal Access Token>#dev.azure.com/<Organization Name>/<Project Name>/_git/<Project Name>.wiki
PS:
Every DevOps project has a hidden repository, which named '<Project Name>.wiki', this repository can't be access via the repository UI list, also can't be listed via the List Repositories REST API. This repository also unable to be managed as other common repositories. Only 'Security for Wiki'. The repository will store all of the information in the pages of wiki permanently unless you delete the file in the repo.
And the comments section of the wiki is implemented quite differently, it is not based on a git repo and does not provide an explicit manage method. If you accidentally delete an image in a comment from the wiki, you won't have any way to get it back.
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).
Living years in confluence+centralized git (bitbucket+github), recently coming to a small shop on MS azure devops, where the repo and wikis scattered between hundred of projects which impossible to find. Would it be a way to structure the azuredevops to make it more 'confluence' like?
Thanks
Would it be a way to structure the azuredevops to make it more 'confluence' like?
I am afraid there is no such a way to structure the azuredevops to make it more 'confluence'.
As we know, the Azure devops is a project-oriented product. Both the repo and the Wiki are based on one project. We can include multiple repo and wiki in a project, but cannot create a repo or wiki for multiple projects.
The workaround is that we could clone Wiki to the target project and Publish the code as wiki, you could check following thread for some more details:
Azure DevOps Wiki for multiple projects
We are using TFS 2015 On Premise, not in the cloud and I am trying to give access to Stakeholders so they can access the wiki. However, as a stakeholder I keep getting this error:
TF400409: You do not have licensing rights to access this feature: Code
After researching the error it seems to be related to the fact that Stakeholders do not have access to view Code Wikis as shown here. That link is for Azure DevOps and I am not sure if it applies to my case but I cannot find anything else so my assumption is it does apply. Even links within our TFS site, takes us to Azure DevOps for help and thus my assumption is it applies to us as well.
Here is a screenshot from the aforementioned link:
Question
What is the difference between Code Wikis and Project Wikis? It seems I need Project Wikis but how do I create a Project Wiki?
Thanks in advance!
Code Wiki are not available on TFS server 2015. You need to use version TFS 2018 or above for this.
Project Wiki
Every team project can have a wiki. Use the wiki to share information
with your team to understand and contribute to your project.
Each team project wiki is powered by a Git repository in the back-end.
When you create a team project, a Wiki Git repo is not created by
default. Provision a Git repository to store your wiki Markdown files,
or publish existing Markdown files from a Git repository to a wiki.
In the project page, you could directly choose to create project wiki.
Code Wiki
Content that you already maintain in a Git repository can be published to a wiki. For example, this could be content written to
support a software development kit (SDK), product documentation, or
README file. You can publish multiple wikis within a single team
project.
More details about the difference of them, kindly refer our official doc here:
Provisioned wikis vs. published code as a wiki
As how to use them in Azure DevOps/TFS, you could also take a look at this step by step tutorial -- Collaborating using Azure DevOps Wiki
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 :)
There are many trivial examples that show how this is done without the Github integration. The Azure Powershell commandlet New-AzureWebsite supports only public repos (can be confirmed from source code [1]). Has anyone tried to create it with a connection to a private repo? It doesn't seem to be documented anywhere.
UPDATE: I've realized this might be something Kudu helps me with.
[1] https://github.com/Azure/azure-powershell/blob/e06a22c22f7a1c8153e9c2fa7c159ae7b1fd1dab/src/ServiceManagement/Services/Commands.Utilities/Websites/Services/GithubClient.cs#L124
We have not added the functionality to powershell. However, you could try using the ARMClient tool below to achieve just that. See its readme and wiki for info.
https://github.com/projectkudu/ARMClient
https://github.com/projectkudu/ARMClient/wiki/Setup-GitHub-publishing-to-Site