Create the rest of the wiki docs

This commit is contained in:
Achilleas Pipinellis 2017-05-02 23:49:27 +02:00
parent 1cb827eea3
commit 58b0841aa7
6 changed files with 51 additions and 5 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.3 KiB

View File

@ -24,28 +24,74 @@ when viewing a Wiki. You only have to fill in the **Content** section and click
**Create page**. You can always edit it later, so go ahead and write a welcome
message.
![New home page](img/wiki_create_new_page.png)
Read more in the [Creating a new wiki page](#creating-a-new-wiki-page) section.
![New home page](img/wiki_create_home_page.png)
## Creating a new wiki page
Create a new page by clicking the **New page** button that can be found
in all wiki pages. You will be asked to fill in the page name from which GitLab
will create the path to the page. You can specify a full path for the new file
and any missing directories will be created automatically.
![New page modal](img/wiki_create_new_page_modal.png)
Once you enter the page name, it's time to fill in its content. GitLab wikis
support Markdown, RDoc and AsciiDoc. 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.
>**Note:**
The wiki is based on a Git repository and contains only text files. Uploading
files via the web interface will upload them in GitLab itself, and they will
not be available if you clone the wiki repo locally.
In the web interface the commit message is optional, but the GitLab Wiki is
based on Git and needs a commit message, so one will be created for you if you
do not enter one.
When you're ready, click the **Create page** and the new page will be created.
![New page](img/wiki_create_new_page.png)
## Editing a wiki page
To edit a page, simply click on the **Edit** button. From there on, you can
change its content. When done, click **Save changes** for the changes to take
effect.
## Deleting a wiki page
You can find the **Delete** button only when editing a page. Click on it and
confirm you want the page to be deleted.
## Viewing a list of all created wiki pages
Every wiki has a sidebar from which a short list of the created pages can be
found. The list is ordered alphabetically.
![Wiki sidebar](img/wiki_sidebar.png)
If you have many pages, not all will be listed in the sidebar. Click on
**More pages** to see all of them.
## Viewing the history of a wiki page
## Using different markup languages
The changes of a wiki page over time are recorded in the wiki's Git repository,
and you can view them by clicking the **Page history** button.
From the history page you can see the revision of the page (Git commit SHA), its
author, the commit message, when it was last updated and the page markup format.
To see how a previous version of the page looked like, click on a revision
number.
![Wiki page history](img/wiki_page_history.png)
## Adding and editing wiki pages locally
## Disabling the wiki from your project
Since wikis are based on Git repositories, you can clone them locally and edit
them like you would do with every other Git repository.
On the right sidebar, click on **Clone repository** and follow the on-screen
instructions.
[permissions]: ../../permissions.md