Commit 1cb827ee authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Fill in information about creating the wiki Home page

parent 75ab1474
...@@ -92,7 +92,7 @@ Take a step ahead and dive into GitLab's advanced features. ...@@ -92,7 +92,7 @@ Take a step ahead and dive into GitLab's advanced features.
- [GitLab Pages](user/project/pages/index.md): Build, test, and deploy your static website with GitLab Pages. - [GitLab Pages](user/project/pages/index.md): Build, test, and deploy your static website with GitLab Pages.
- [Snippets](user/snippets.md): Snippets allow you to create little bits of code. - [Snippets](user/snippets.md): Snippets allow you to create little bits of code.
- [Wikis](workflow/project_features.md#wiki): Enhance your repository documentation with built-in wikis. - [Wikis](user/project/wiki/index.md): Enhance your repository documentation with built-in wikis.
### Continuous Integration, Delivery, and Deployment ### Continuous Integration, Delivery, and Deployment
......
# Wiki # Wiki
Each project has a Wiki, where you can create a Wiki in the web interface or A separate system for documentation called Wiki, is built right into each
locally, and collaborate on it with your team using the full power of Git. 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 Wikis are very convenient if you don't want to keep you documentation in your
to create and edit Wiki pages. Contact a Project Admin if you need access. 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.
![New home page](img/wiki_create_new_page.png)
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 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 based on Git and needs a commit message, so one will be created for you if you
do not enter one. 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
...@@ -26,6 +26,8 @@ This is a separate system for documentation, built right into GitLab. ...@@ -26,6 +26,8 @@ This is a separate system for documentation, built right into GitLab.
It is source controlled and is very convenient if you don't want to keep you documentation in your source code, but you do want to keep it in your GitLab project. It is source controlled and is very convenient if you don't want to keep you documentation in your source code, but you do want to keep it in your GitLab project.
[Read more about Wikis.](../user/project/wiki/index.md)
## Snippets ## Snippets
Snippets are little bits of code or text. Snippets are little bits of code or text.
......
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