diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-05-02 20:07:07 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2017-05-03 00:38:21 +0200 |
| commit | 1cb827eea39c51459a41381805ab2ab2eb88d6a5 (patch) | |
| tree | 516eec0048551adb8a29911d7fd804a84f9154bf /doc/user | |
| parent | 75ab1474b3d211a6894626ea6a2df413a0edb898 (diff) | |
| download | gitlab-ce-1cb827eea39c51459a41381805ab2ab2eb88d6a5.tar.gz | |
Fill in information about creating the wiki Home page
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/project/wiki/img/wiki_create_new_page.png | bin | 0 -> 12562 bytes | |||
| -rw-r--r-- | doc/user/project/wiki/index.md | 53 |
2 files changed, 43 insertions, 10 deletions
diff --git a/doc/user/project/wiki/img/wiki_create_new_page.png b/doc/user/project/wiki/img/wiki_create_new_page.png Binary files differnew file mode 100644 index 00000000000..d5dcca3d9fe --- /dev/null +++ b/doc/user/project/wiki/img/wiki_create_new_page.png diff --git a/doc/user/project/wiki/index.md b/doc/user/project/wiki/index.md index cfd6d225e2c..1b27162c66a 100644 --- a/doc/user/project/wiki/index.md +++ b/doc/user/project/wiki/index.md @@ -1,18 +1,51 @@ # Wiki -Each project has a Wiki, where you can create a Wiki in the web interface or -locally, and collaborate on it with your team using the full power of Git. +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. -A permission level of **Guest** is needed to view a Wiki and **Developer** is needed -to create and edit Wiki pages. Contact a Project Admin if you need access. +Wikis are very convenient if you don't want to keep you documentation in your +repository, but you do want to keep it in the same project where your code +resides. -## Getting Started: Create the Home Page +You can create Wiki pages in the web interface or +[locally using Git](#adding-and-editing-wiki-pages-locally) since every Wiki is +a separate Git repository. + +>**Note:** +A [permission level][permissions] of **Guest** is needed to view a Wiki and +**Developer** is needed to create and edit Wiki pages. + +## First time creating the Home page + +The first time you visit a Wiki, you will be directed to create the Home page. +The Home page is necessary to be created since it serves as the landing page +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. + + + +Read more in the [Creating a new wiki page](#creating-a-new-wiki-page) section. + +## Creating a new wiki page -1. When viewing your project, click on **Wiki**. -1. You will be taken to `/home` of your Wiki, this is where users will land -when they visit your Wiki. You will be asked to create the home page if it -doesn't exist. -1. You only have to fill in the **Content** section and click **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 will be created for you if you do not enter one. + +## Editing a wiki page + +## Deleting a wiki page + +## Viewing a list of all created wiki pages + +## Viewing the history of a wiki page + +## Using different markup languages + +## Adding and editing wiki pages locally + +## Disabling the wiki from your project + +[permissions]: ../../permissions.md |
