summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJoram Wilander <jwawilander@gmail.com>2015-09-07 08:21:47 -0400
committerJoram Wilander <jwawilander@gmail.com>2015-09-07 08:21:47 -0400
commit30cfc99fe7af647a94098fcdf2f3fcf714cb9d78 (patch)
tree2e45725e038197c4fe468289302d0411ad5a9bd2 /doc
parent6ecaee9eacab871b63ababcf7c0db7f77da73fc2 (diff)
parent1c394f32a1c1b85e194c99bc77b31e36e7567994 (diff)
downloadchat-30cfc99fe7af647a94098fcdf2f3fcf714cb9d78.tar.gz
chat-30cfc99fe7af647a94098fcdf2f3fcf714cb9d78.tar.bz2
chat-30cfc99fe7af647a94098fcdf2f3fcf714cb9d78.zip
Merge pull request #618 from mattermost/it33-patch-2
Multiple documentation improvements
Diffstat (limited to 'doc')
-rw-r--r--doc/README.md4
-rw-r--r--doc/install/release-numbering.md17
-rw-r--r--doc/install/single-container-install.md7
3 files changed, 23 insertions, 5 deletions
diff --git a/doc/README.md b/doc/README.md
index ac00dc976..36d16b744 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,5 +1,9 @@
# Mattermost Documentation
+## General Information
+
+- [Mattermost Release Numbering Scheme](install/release-numbering.md)
+
## Administrator Documentation
### Installation
diff --git a/doc/install/release-numbering.md b/doc/install/release-numbering.md
new file mode 100644
index 000000000..71374f7ef
--- /dev/null
+++ b/doc/install/release-numbering.md
@@ -0,0 +1,17 @@
+### Mattermost Release Numbering
+
+Mattermost numbers its stable releases based on the following format:
+
+ `[Version Number].[Major Build Number].[Minor Build Number]`
+
+Version Number:
+
+- Indicates a major system release (e.g. 1.x.x, 2.x.x)
+
+Major Build Number:
+
+- Indicates significant new functionality, (e.g. 0.5.x, 0.6.x, 0.7.x)
+
+Minor Build Number:
+
+- Indicates bugfix/security releases (e.g. 1.2.5, 1.2.6)
diff --git a/doc/install/single-container-install.md b/doc/install/single-container-install.md
index 3e307ca74..772f3becf 100644
--- a/doc/install/single-container-install.md
+++ b/doc/install/single-container-install.md
@@ -1,10 +1,7 @@
-# Single Container Installation and Upgrade
+# Local Machine Setup and Upgrade
The following install instructions are for single-container installs of Mattermost using Docker for exploring product functionality and upgrading to newer versions.
-Local Machine Setup (Docker)
------------------------------
-
### Mac OSX ###
1. Install Boot2Docker using instructions at: http://docs.docker.com/installation/mac/
@@ -89,7 +86,7 @@ There are a few configuration settings you might want to adjust when setting up
The default single-container Docker instance for Mattermost is designed for product evaluation, and sets `ByPassEmail=true` so the product can run without enabling email, when doing so maybe difficult.
-To see the product's full functionality, [enabling SMTP email is recommended](doc/config/smtp-email-setup.md).
+To see the product's full functionality, [enabling SMTP email is recommended](/doc/config/smtp-email-setup.md).
## Upgrading Mattermost