Skip to content

G
gitlab-ce
Commit 51f60a33 authored by Craig Norris's avatar Craig Norris
Browse files
Options

Merge branch '324959-aqualls-revise-wiki' into 'master' 

Revisions part 2 of wiki: crosslinks + partial rewrite

See merge request gitlab-org/gitlab!57749
parents dfba63c3 270e61c7
Hide whitespace changes
Inline Side-by-side
Showing with 87 additions and 73 deletions
app/assets/javascripts/pages/shared/wikis/components/wiki_form.vue
View file @ 51f60a33
......@@ -40,7 +40,7 @@ export default {
helpPath() {
return setUrlFragment(
this.pageInfo.helpPath,
this.pageInfo.persisted ? 'moving-a-wiki-page' : 'creating-a-new-wiki-page',
this.pageInfo.persisted ? 'move-a-wiki-page' : 'create-a-new-wiki-page',
);
},
commitMessageI18n() {
......
doc/administration/geo/replication/datatypes.md
View file @ 51f60a33
......@@ -175,7 +175,7 @@ successfully, you must replicate their data using some other means.
| [Application data in PostgreSQL](../../postgresql/index.md) | **Yes** (10.2) | **Yes** (10.2) | No | |
| [Project repository](../../../user/project/repository/) | **Yes** (10.2) | **Yes** (10.7) | No | |
| [Project wiki repository](../../../user/project/wiki/) | **Yes** (10.2) | **Yes** (10.7) | No |
| [Group wiki repository](../../../user/group/index.md#group-wikis) | [**Yes** (13.10)](https://gitlab.com/gitlab-org/gitlab/-/issues/208147) | No | No | Behind feature flag `geo_group_wiki_repository_replication`, enabled by default |
| [Group wiki repository](../../../user/project/wiki/index.md#group-wikis) | [**Yes** (13.10)](https://gitlab.com/gitlab-org/gitlab/-/issues/208147) | No | No | Behind feature flag `geo_group_wiki_repository_replication`, enabled by default |
| [Uploads](../../uploads.md) | **Yes** (10.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | No | Verified only on transfer or manually using [Integrity Check Rake Task](../../raketasks/check.md) on both sites and comparing the output between them. |
| [LFS objects](../../lfs/index.md) | **Yes** (10.2) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/8922) | Via Object Storage provider if supported. Native Geo support (Beta). | Verified only on transfer or manually using [Integrity Check Rake Task](../../raketasks/check.md) on both sites and comparing the output between them. GitLab versions 11.11.x and 12.0.x are affected by [a bug that prevents any new LFS objects from replicating](https://gitlab.com/gitlab-org/gitlab/-/issues/32696). |
| [Personal snippets](../../../user/snippets.md) | **Yes** (10.2) | **Yes** (10.2) | No | |
......
doc/administration/wikis/index.md
View file @ 51f60a33
......@@ -73,3 +73,9 @@ You can also use the API to [retrieve the current value](../../api/settings.md#g
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings"
```
## Related topics
- [User documentation for wikis](../../user/project/wiki/index.md)
- [Project wikis API](../../api/wikis.md)
- [Group wikis API](../../api/group_wikis.md)
doc/api/group_wikis.md
View file @ 51f60a33
......@@ -9,7 +9,8 @@ type: reference, api
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/212199) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5.
Available only in APIv4.
The [group wikis](../user/project/wiki/index.md#group-wikis) API is available only in APIv4.
An API for [project wikis](wikis.md) is also available.
## List wiki pages
......
doc/api/wikis.md
View file @ 51f60a33
......@@ -9,7 +9,8 @@ type: reference, api
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13372) in GitLab 10.0.
Available only in APIv4.
The project [wikis](../user/project/wiki/index.md) API is available only in APIv4.
An API for [group wikis](group_wikis.md) is also available.
## List wiki pages
......
doc/user/group/index.md
View file @ 51f60a33
......@@ -20,6 +20,7 @@ Then you can:
[merge requests](../project/merge_requests/reviewing_and_managing_merge_requests.md#view-merge-requests-for-all-projects-in-a-group)
for all projects in the group, together in a single list view.
- [Bulk edit](../group/bulk_editing/index.md) issues, epics, and merge requests.
- [Create a wiki](../project/wiki/index.md) for the group.
You can also create [subgroups](subgroups/index.md).
......@@ -322,25 +323,6 @@ LDAP user permissions can be manually overridden by an administrator. To overrid
Now you can edit the user's permissions from the **Members** page.
## Group wikis **(PREMIUM)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5.
Group wikis work the same way as [project wikis](../project/wiki/index.md).
Group wikis can be edited by members with [Developer permissions](../../user/permissions.md#group-members-permissions)
and above.
You can move group wiki repositories by using the [Group repository storage moves API](../../api/group_repository_storage_moves.md).
There are a few limitations compared to project wikis:
- Git LFS is not supported.
- Group wikis are not included in global search.
- Changes to group wikis don't show up in the group's activity feed.
For updates, follow [the epic that tracks feature parity with project wikis](https://gitlab.com/groups/gitlab-org/-/epics/2782).
## Transfer a group
You can transfer groups in the following ways:
......@@ -629,6 +611,7 @@ The group's new subgroups have push rules set for them based on either:
## Related topics
- [Group wikis](../project/wiki/index.md)
- [Maximum artifacts size](../admin_area/settings/continuous_integration.md#maximum-artifacts-size). **(FREE SELF)**
- [Repositories analytics](repositories_analytics/index.md): View overall activity of all projects with code coverage. **(PREMIUM)**
- [Contribution analytics](contribution_analytics/index.md): View the contributions (pushes, merge requests,
......
doc/user/permissions.md
View file @ 51f60a33
......@@ -209,7 +209,7 @@ The following table depicts the various user permission levels in a project.
### Wiki and issues
Project features like wiki and issues can be hidden from users depending on
Project features like [wikis](project/wiki/index.md) and issues can be hidden from users depending on
which visibility level you select on project settings.
- Disabled: disabled for everyone
......
doc/user/project/wiki/index.md
View file @ 51f60a33
......@@ -7,68 +7,61 @@ type: reference, how-to
# Wiki **(FREE)**
A separate system for documentation called Wiki, is built right into each
GitLab project. It is enabled by default on all new projects and you can find
it under **Wiki** in your project.
If you don't want to keep your documentation in your repository, but you do want
to keep it in the same project as your code, you can use the wiki GitLab provides
in each GitLab project. Every wiki is a separate Git repository, so you can create
wiki pages in the web interface, or [locally using Git](#create-or-edit-wiki-pages-locally).
Wikis are very convenient if you don't want to keep your documentation in your
repository, but you do want to keep it in the same project where your code
resides.
You can create Wiki pages in the web interface or
[locally using Git](#create-or-edit-wiki-pages-locally) since every Wiki is
a separate Git repository.
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5,
**group wikis** became available. Their usage is similar to project wikis, with a few [limitations](../../group/index.md#group-wikis).
To access the wiki for a project or group, go to the page for your project or group
and, in the left sidebar, select **Wiki**. If **Wiki** is not listed in the
left sidebar, a project administrator has [disabled it](#enable-or-disable-a-project-wiki).
## Create the wiki home page
The first time you visit a Wiki, you are directed to create the Home page.
The Home page is necessary to be created because it serves as the landing page
when viewing a Wiki. Complete the **Content** section, and then select
**Create page**. You can always edit it later, so go ahead and write a welcome
message.
When a wiki is created, it is empty. On your first visit, GitLab instructs you
to create a page to serve as the landing page when a user views the wiki:
![New home page](img/wiki_create_home_page.png)
1. Select a **Format** for [styling your text](#style-your-wiki-content).
1. Add a welcome message in the **Content** section. You can always edit it later.
1. Add a **Commit message**. Git requires a commit message, so GitLab creates one
if you don't enter one yourself.
1. Select **Create page**.
## Create a new wiki page
NOTE:
Requires Developer [permissions](../../permissions.md).
Create a new page by selecting the **New page** button that can be found
in all wiki pages.
Enter a title for your new wiki page.
You can specify a full path for the wiki page by using '/' in the
title to indicate subdirectories. Any missing directories are created
automatically. For example, a title of `docs/my-page` creates a wiki
page with a path `/wikis/docs/my-page`.
Users with Developer [permissions](../../permissions.md) can create new wiki pages:
After you enter the page name, it's time to fill in its content. GitLab wikis
support Markdown, RDoc, AsciiDoc, and Org. For Markdown based pages, all the
[Markdown features](../../markdown.md) are supported and for links there is
some [wiki specific](../../markdown.md#wiki-specific-markdown) behavior.
1. Go to the page for your project or group.
1. In the left sidebar, select **Wiki**.
1. Select **New page** on this page, or any other wiki page.
1. Select a [content format](#style-your-wiki-content).
1. Add a title for your new page. You can specify a full path for the wiki page
by using `/` in the title to indicate subdirectories. GitLab creates any missing
subdirectories in the path. For example, a title of `docs/my-page` creates a wiki
page with a path `/wikis/docs/my-page`.
1. Add content to your wiki page.
1. Add a **Commit message**. Git requires a commit message, so GitLab creates one
if you don't enter one yourself.
1. Select **Create page**.
In the web interface the commit message is optional, but the GitLab Wiki is
based on Git and needs a commit message, so one is created for you if you
don't enter one.
## Style your wiki content
When you're ready, select **Create page** and the new page is created.
GitLab wikis support Markdown, RDoc, AsciiDoc, and Org for content.
![New page](img/wiki_create_new_page.png)
Wiki pages written in Markdown support all [Markdown features](../../markdown.md),
and also provide some [wiki-specific behavior](../../markdown.md#wiki-specific-markdown)
for links.
### Store attachments for wiki pages
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33475) in GitLab 11.3.
Any file uploaded to the wiki with the GitLab
interface is stored in the wiki Git repository, and is available
if you clone the wiki repository locally. All uploaded files prior to GitLab
11.3 are stored in GitLab itself. If you want them to be part of the wiki's Git
repository, you must upload them again.
When you upload a file to the wiki through the GitLab interface, the file is stored
in the wiki's Git repository. The file is available to you if you clone the
wiki repository locally.
Files uploaded to a wiki in GitLab 11.3 and earlier are stored in GitLab itself.
You must re-upload the files to add them to the wiki's Git repository.
### Special characters in page titles
......@@ -226,6 +219,36 @@ Example for `_sidebar` (using Markdown format):
Support for displaying a generated table of contents with a custom side navigation is planned.
## Group wikis **(PREMIUM)**
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13195) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5.
Group wikis work the same way as project wikis. Their usage is similar to project wikis, with a few limitations.
Group wikis can be edited by members with [Developer permissions](../../permissions.md#group-members-permissions)
and above.
You can move group wiki repositories by using the [Group repository storage moves API](../../../api/group_repository_storage_moves.md).
There are a few limitations compared to project wikis:
- Git LFS is not supported.
- Group wikis are not included in global search.
- Changes to group wikis don't show up in the group's activity feed.
For updates, follow [the epic that tracks feature parity with project wikis](https://gitlab.com/groups/gitlab-org/-/epics/2782).
## Enable or disable a project wiki
Wikis are enabled by default in GitLab. Project [administrators](../../permissions.md)
can enable or disable the project wiki by following the instructions in
[Sharing and permissions](../settings/index.md#sharing-and-permissions).
Administrators for self-managed GitLab installs can
[configure additional wiki settings](../../../administration/wikis/index.md).
## Resources
- [Group wikis](../../group/index.md#group-wikis)
- [Wiki settings for administrators](../../../administration/wikis/index.md)
- [Project wikis API](../../../api/wikis.md)
- [Group wikis API](../../../api/group_wikis.md)
doc/user/snippets.md
View file @ 51f60a33
......@@ -127,7 +127,7 @@ A single snippet can support up to 10 files, which helps keep related files toge
If you need more than 10 files for your snippet, we recommend you a create a
[wiki](project/wiki/index.md) instead. Wikis are available for projects at all
subscription levels, and [groups](group/index.md#group-wikis) for
subscription levels, and [groups](project/wiki/index.md#group-wikis) for
[GitLab Premium](https://about.gitlab.com/pricing).
Snippets with multiple files display a file count in the [snippet list](http://snippets.gitlab.com/):
......
spec/frontend/pages/shared/wikis/components/wiki_form_spec.js
View file @ 51f60a33
......@@ -120,8 +120,8 @@ describe('WikiForm', () => {
it.each`
persisted | titleHelpText | titleHelpLink
${true} | ${'You can move this page by adding the path to the beginning of the title.'} | ${'/help/user/project/wiki/index#moving-a-wiki-page'}
${false} | ${'You can specify the full path for the new file. We will automatically create any missing directories.'} | ${'/help/user/project/wiki/index#creating-a-new-wiki-page'}
${true} | ${'You can move this page by adding the path to the beginning of the title.'} | ${'/help/user/project/wiki/index#move-a-wiki-page'}
${false} | ${'You can specify the full path for the new file. We will automatically create any missing directories.'} | ${'/help/user/project/wiki/index#create-a-new-wiki-page'}
`(
'shows appropriate title help text and help link for when persisted=$persisted',
async ({ persisted, titleHelpLink, titleHelpText }) => {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7