summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDe Wet Blomerus <dewet@blomerus.org>2016-10-14 10:57:32 +0200
committerDe Wet Blomerus <dewet@blomerus.org>2016-12-21 10:40:01 +0200
commit1d85d4cde8555db48c232ba7afc1817b3bc8568b (patch)
treeea8a530e33f10ceaf3dcc22b289efe0e974eed74
parentdad3b0e0dd6e8ae6b521587a2f2afdcfea1541b2 (diff)
downloadgitlab-ce-wiki-doc.tar.gz
Create initial file for Wiki documentationwiki-doc
-rw-r--r--doc/README.md1
-rw-r--r--doc/user/project/wiki.md18
2 files changed, 19 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
index ee69684b53b..2abbc9b7dc6 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -18,6 +18,7 @@
- [Public access](public_access/public_access.md) Learn how you can allow public and internal access to projects.
- [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects.
- [Webhooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project.
+- [Wiki](user/project/wiki.md) Create a Wiki and use Git to collaborate on it.
- [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN.
- [University](university/README.md) Learn Git and GitLab through videos and courses.
- [Git Attributes](user/project/git_attributes.md) Managing Git attributes using a `.gitattributes` file.
diff --git a/doc/user/project/wiki.md b/doc/user/project/wiki.md
new file mode 100644
index 00000000000..cfd6d225e2c
--- /dev/null
+++ b/doc/user/project/wiki.md
@@ -0,0 +1,18 @@
+# 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 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.
+
+## Getting Started: Create the Home 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.