From 58b0841aa7ae96501433367b25aa6468bce38c7a Mon Sep 17 00:00:00 2001 From: Achilleas Pipinellis Date: Tue, 2 May 2017 23:49:27 +0200 Subject: Create the rest of the wiki docs --- .../project/wiki/img/wiki_create_home_page.png | Bin 0 -> 12422 bytes doc/user/project/wiki/img/wiki_create_new_page.png | Bin 12562 -> 38105 bytes .../wiki/img/wiki_create_new_page_modal.png | Bin 0 -> 13189 bytes doc/user/project/wiki/img/wiki_page_history.png | Bin 0 -> 26478 bytes doc/user/project/wiki/img/wiki_sidebar.png | Bin 0 -> 7440 bytes doc/user/project/wiki/index.md | 56 +++++++++++++++++++-- 6 files changed, 51 insertions(+), 5 deletions(-) create mode 100644 doc/user/project/wiki/img/wiki_create_home_page.png create mode 100644 doc/user/project/wiki/img/wiki_create_new_page_modal.png create mode 100644 doc/user/project/wiki/img/wiki_page_history.png create mode 100644 doc/user/project/wiki/img/wiki_sidebar.png diff --git a/doc/user/project/wiki/img/wiki_create_home_page.png b/doc/user/project/wiki/img/wiki_create_home_page.png new file mode 100644 index 00000000000..f50f564034c Binary files /dev/null and b/doc/user/project/wiki/img/wiki_create_home_page.png differ diff --git a/doc/user/project/wiki/img/wiki_create_new_page.png b/doc/user/project/wiki/img/wiki_create_new_page.png index d5dcca3d9fe..c19124a8923 100644 Binary files a/doc/user/project/wiki/img/wiki_create_new_page.png and b/doc/user/project/wiki/img/wiki_create_new_page.png differ diff --git a/doc/user/project/wiki/img/wiki_create_new_page_modal.png b/doc/user/project/wiki/img/wiki_create_new_page_modal.png new file mode 100644 index 00000000000..ece437967dc Binary files /dev/null and b/doc/user/project/wiki/img/wiki_create_new_page_modal.png differ diff --git a/doc/user/project/wiki/img/wiki_page_history.png b/doc/user/project/wiki/img/wiki_page_history.png new file mode 100644 index 00000000000..0e6af1b468d Binary files /dev/null and b/doc/user/project/wiki/img/wiki_page_history.png differ diff --git a/doc/user/project/wiki/img/wiki_sidebar.png b/doc/user/project/wiki/img/wiki_sidebar.png new file mode 100644 index 00000000000..59814e2a06e Binary files /dev/null and b/doc/user/project/wiki/img/wiki_sidebar.png differ diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index 1b27162c66a..e9ee1abc6c1 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -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 -- cgit v1.2.1