You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Begin by connecting to your project using a [supported web browser](/tfs/server/compatibility#supported-browsers) and choose **Wiki**.
5
5
6
-
7
6
> [!NOTE]
8
-
> Choose **Previous navigation** when you see a top-level blue bar. Choose **New navigation** if you see a vertical sidebar or if you enabled the **New Navigation** preview feature. The vertical sidebar, along with other navigational features, is enabled when the **New Navigation** preview feature has been enabled for the signed-in user or the Azure DevOps organization. To learn how to use the web portal effectively, see [Web portal navigation](/azure/devops/project/navigation/index).
9
-
>
10
-
> For on-premises TFS, choose **Previous Navigation** for guidance.
7
+
> Choose **Previous navigation** when you see a top-level blue bar. Choose **New navigation** if you see a vertical sidebar or if you enabled the **New Navigation** preview feature. The vertical sidebar, along with other navigational features, is enabled when the **New Navigation** preview feature has been enabled for the signed-in user or the Azure DevOps organization. To learn how to use the web portal effectively, see [Web portal navigation](/azure/devops/project/navigation/index).
8
+
>
9
+
> For on-premises TFS, choose **Previous Navigation** for guidance.
11
10
12
11
# [New navigation](#tab/new-nav)
13
12
14
-
::: moniker range="vsts"
13
+
::: moniker range="vsts"
15
14
16
15
> [!div class="mx-imgBorder"]
17
16
> 
18
17
19
-
If you need to switch your team project, choose the  Azure DevOps logo to [browse all team projects and teams](/azure/devops/project/navigation/work-across-projects).
20
-
21
-
::: moniker-end
18
+
If you need to switch your team project, select the  Azure DevOps logo to [browse all team projects and teams](/azure/devops/project/navigation/work-across-projects).
19
+
20
+
::: moniker-end
22
21
23
-
::: moniker range="tfs-2018"
24
-
**New navigation** isn't supported on TFS at this time. Choose**Previous navigation** for guidance.
25
-
::: moniker-end
22
+
::: moniker range="tfs-2018"
23
+
**New navigation** isn't supported on TFS at this time. Select**Previous navigation** for guidance.
- If you need to switch your team project, choose the  Azure DevOps logo to [browse all team projects and teams](/azure/devops/project/navigation/work-across-projects).
33
-
- If you don't see **Wiki**, your screen size may be reduced. Choose the  three dots (elipses), then choose**Wiki>Wiki**.
31
+
- If you need to switch your team project, select the  Azure DevOps logo to [browse all team projects and teams](/azure/devops/project/navigation/work-across-projects).
32
+
- If you don't see **Wiki**, your screen size may be reduced. Select the  three dots (elipses), and then select**Wiki>Wiki**.
To support your team or contributors to your project, use [Markdown](https://en.wikipedia.org/wiki/Markdown) to add rich formatting, tables, and images to your team project. You can use Markdown format within a team project Wiki, content you add to a dashboard, within your team project README file, or other repository README file.
To support your team or contributors to your project, use [Markdown](https://en.wikipedia.org/wiki/Markdown) to add rich formatting, tables, and images to your team project. You can use Markdown format within content you add to a dashboard, within your team project README file, or other repository README file.
33
34
34
35
::: moniker-end
35
36
36
37
::: moniker range=">= tfs-2015"
37
38
38
-
## Markdown
39
+
## Markdown
39
40
40
-
Markdown makes it easy to format text, include images, and link as needed to additional documentation within your project pages, readme files, dashboards, and pull request comments.
41
+
Markdown makes it easy to format text, include images, and link as needed to additional documentation within your project pages, README files, dashboards, and pull request comments.
41
42
42
-
You can provide guidance to your team in these places using Markdown:
43
+
You can provide guidance to your team in the following places using Markdown:
43
44
44
45
::: moniker-end
45
46
46
-
::: moniker range="vsts"
47
+
::: moniker range="vsts"
47
48
48
49
-[Team project wiki (provisioned wiki)](add-edit-wiki.md)
49
50
-[Publish code as wiki](publish-repo-to-wiki.md)
50
51
-[Add Markdown to a dashboard](../../report/dashboards/add-markdown-to-dashboard.md)
51
-
-[Project vision page or Welcome pages](project-vision-status.md)
For supported syntax, see [Syntax guidance for Markdown files, widgets, wikis, and pull request comments](markdown-guidance.md).
78
78
79
-
80
-
::: moniker range=">= tfs-2015"
79
+
::: moniker range=">= tfs-2015"
81
80
82
81
## READMEs
83
82
84
-
You can define a README file, or multiple files, for each repo or team project. Write your readme in Markdown instead of plain text.
83
+
You can define a README file, or multiple files, for each repo or team project. Write your README in Markdown instead of plain text.
85
84
86
-
Use README pages to orient contributors to working within your project. Consider adding guidance about:
87
-
- The project focus
85
+
Use README pages to orient contributors to working within your project. Consider adding guidance about the following:
86
+
87
+
- The project focus
88
88
- Prerequisites
89
89
- Setting up the environment
90
90
- Tips for getting things done within the project
@@ -93,7 +93,7 @@ Use README pages to orient contributors to working within your project. Consider
93
93
- Workflow guidance about committing or uploading changes and adding branches
94
94
- Project sponsors or contacts
95
95
96
-
Here are some great readmes that use this format and speak to all three audiences, for reference and inspiration:
96
+
Here are some great READMEs that use this format and speak to all three audiences, for reference and inspiration:
97
97
98
98
-[ASP.NET Core](https://github.com/aspnet/Home)
99
99
-[Visual Studio Code](https://github.com/Microsoft/vscode)
@@ -105,41 +105,43 @@ Here are some great readmes that use this format and speak to all three audience
105
105
106
106
## Wiki
107
107
108
-
Use your team project wiki to share information with other team members. When you provision a wiki from scratch, a Git repository is created to store your markdown files, images, attachments, and the sequence of pages. This wiki supports collaborative editing of its content and structure.
108
+
Use your team project wiki to share information with other team members. When you provision a wiki from scratch, a Git repository is created to store your markdown files, images, attachments, and the sequence of pages. This wiki supports collaborative editing of its content and structure.
109
109
110
110
::: moniker-end
111
111
112
112
::: moniker range="tfs-2018"
113
113
> [!NOTE]
114
-
> The built-in wiki is available with TFS 2018 and later versions. To download TFS 2018, see [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/).
114
+
> The built-in wiki is available with TFS 2018 and later versions. To download TFS 2018, see [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/).
115
115
::: moniker-end
116
116
117
117
::: moniker range="vsts"
118
118
119
-
The following features are supported for the team project wiki.
119
+
The following features are supported for the team project wiki.
120
120
121
121
**Provision or create a wiki**
122
+
122
123
-[Create a wiki for your team project](wiki-create-repo.md)
123
-
-[Publish code as wiki](publish-repo-to-wiki.md)
124
+
-[Publish code as wiki](publish-repo-to-wiki.md)
124
125
125
126
**Work with wiki content**
126
127
127
128
-[Add and edit wiki pages](add-edit-wiki.md)
128
129
-[View wiki page history and revert](wiki-view-history.md)
129
130
-[Search Wiki content](search-wiki.md)
130
-
-[Version, select, or unpublish a published wiki](wiki-select-unpublish-versions.md)
131
-
-[Clone and update wiki content offline](wiki-update-offline.md)
132
-
-[Use Wiki keyboard shortcuts](wiki-keyboard-shortcuts.md)
131
+
-[Version, select, or un-publish a published wiki](wiki-select-unpublish-versions.md)
132
+
-[Clone and update wiki content offline](wiki-update-offline.md)
133
+
-[Use Wiki keyboard shortcuts](wiki-keyboard-shortcuts.md)
133
134
-[Filter or print Wiki content](filter-print-wiki.md) <sup>1</sup>
134
135
135
-
**Note:**
136
-
1. The print feature may not be available from the Firefox web browser.
136
+
> [!NOTE]
137
+
>The print feature may not be available from the Firefox web browser.
137
138
138
139
**Format wiki content**
140
+
139
141
-[Markdown format](markdown-guidance.md)
140
142
-[HTML tags](markdown-guidance.md#html)
141
-
-[Insert and resize images](markdown-guidance.md#images)
142
-
-[Link to work items using #](markdown-guidance.md#link-work-items)
143
+
-[Insert and resize images](markdown-guidance.md#images)
144
+
-[Link to work items using #](markdown-guidance.md#link-work-items)
143
145
-[Attach files](markdown-guidance.md#attach)
144
146
-[Mathematical notation and characters](markdown-guidance.md#mathematical-notation)
145
147
-[Table of contents (TOC) for Wiki pages](markdown-guidance.md#toc-wiki)
@@ -148,40 +150,41 @@ The following features are supported for the team project wiki.
148
150
149
151
::: moniker range="tfs-2018"
150
152
151
-
The following features are supported for the team project wiki you create in the indicated TFS version or later versions. To learn more, see [Create a wiki for your team project](wiki-create-repo.md) and [Add and edit wiki pages](add-edit-wiki.md).
153
+
The following features are supported for the team project wiki you create in the indicated TFS version or later versions. To learn more, see [Create a wiki for your team project](wiki-create-repo.md) and [Add and edit wiki pages](add-edit-wiki.md).
1. This feature may not be available from the Firefox web browser.
170
+
> [!NOTE]
171
+
>This feature may not be available from the Firefox web browser.
170
172
171
173
::: moniker-end
172
174
173
175
::: moniker range="vsts"
176
+
174
177
## Publish existing Git repositories to a wiki
175
178
176
-
Many teams document their code using markdown and check in these files along with the code. While Git supports the maintenance and review of such documentation along with standard pull requests, such files present a few challenges to consumers of the content.
179
+
Many teams document their code using markdown and check in these files along with the code. While Git supports the maintenance and review of such documentation along with standard pull requests, such files present a few challenges to consumers of the content.
177
180
178
-
- Readers must often sift through multiple files and folders to find the content of interest.
181
+
- Readers must often sift through multiple files and folders to find the content of interest.
179
182
- Content lacks organization and structure. There is no inherent page hierarchy to support readers.
180
-
- Content versioning is not supported.
181
-
- Searching through content relies on searching the code, rather than a search experience optimized for searching content.
183
+
- Content versioning is not supported.
184
+
- Searching through content relies on searching the code, rather than a search experience optimized for searching content.
182
185
183
186
With the publish code as wiki feature, you can publish one or more Git repositories defined in your team project to a wiki. This feature addresses the challenges by providing a way to maintain your content alongside your code base, but selectively publish and update your content to a wiki.
184
187
185
-
There are several significant differences between how you manage the content for a wiki that you provision for a team project versus wiki pages that you publish from a Git repository. For details, see
186
-
188
+
There are several significant differences between how you manage the content for a wiki that you provision for a team project versus wiki pages that you publish from a Git repository. For details, see [Publish a Git repo to a wiki](publish-repo-to-wiki.md).
0 commit comments