Merge pull request #917 from mattermost/plt-420

Adding doc system to build. Updated docs, fixed links.

.travis.yml

@@ -20,6 +20,7 @@ before_install:
 - sudo sed -i'' 's/log_slow_queries/slow_query_log/' /etc/mysql/my.cnf
 - sudo sed -i'' 's/basedir[^=]\+=.*$/basedir = \/opt\/mysql\/server-5.6/' /etc/mysql/my.cnf
 - sudo /etc/init.d/mysql.server start
+- sudo pip install mkdocs
 install:
 - export PATH=$PATH:$HOME/gopath/bin
 - go get github.com/tools/godep
@@ -37,6 +38,7 @@ addons:
   hosts:
   - 127.0.0.1 dockerhost
 deploy:
+# Github releases, builds only on tags
  - provider: releases
    api_key:
      secure: ma8Y0oimU+LB6LTAh8to2E1/ghaDPhcsAFXBrODsHpd4JgxA6HYoEwSEBCJFHSpu/JteclsxSTfp9hcuzw/IOtlwlSAiVoBZ60s24MRKTIAQNtrJ4QrX5wyfAZi+Bcuk/E8NynmoIW5qpaElSAdjgocyjAJIQ5ChMEztglL0cAEBXQRWbWMqSZ0hVLPrKDCIkWIyv3pFxqdLOxktkzxW07r2dlT0hppXR3dCaPJo0nelArS2H3LdN/3Iv6cAddfS27RaZkqDj/PDh6OZr4EguC99TxlVNChIr7nPr3/OiAssbkvEnhlSLeABFO9+7KfutL2WhAjpFXTjtPVq6Qalc8UW0K0gxq//sVfhb1MzjenmdOf06uB2bilQ8kgwHo7dDdRZBqqAtxQ6Q0Ht3SFMj6v/1zVD3s+YX/kWCEbUTHm6r2G/eF794ozcJyU+6j1L8hm6mvf8Mr9XCqBfgpZy6FCLX+9OKdMvX2jY8reo3Xz1PA9R6yzhN08vjku+jW+fsoYrBLd0fY1UGK2uOuvBByCeJzXupd3YpBMjEyRupVxqEj7K0GWOJeml65mkqKSNsHdDSeSjMpb8mwneZyTbdjsxCFQRLcLgpAajFrkk4G2Yz3KfhXSo29XKEGX+EbY5NuP8KmDsBsguPI0zfwv/co0hAY8PIIcehxcdoR9Vb2c=
@@ -48,6 +50,7 @@ deploy:
      go: 1.4.2
      condition: $TRAVIS_DB = mysql
 
+# S3 deploy for master docker image. (latest compiled bits)
  - provider: s3
    access_key_id: AKIAJCO3KJYEGWJIKDIQ
    secret_access_key:
@@ -63,3 +66,20 @@ deploy:
      branch: master
      go: 1.4.2
      condition: $TRAVIS_DB = mysql
+
+# S3 deploy for documentation
+ - provider: s3
+   access_key_id: AKIAJCO3KJYEGWJIKDIQ
+   secret_access_key:
+     secure: p66X2tJBmKgtcVyPtGgkAwW29IiRojqGA39RjCJkIWNTJ0e/9JvBOiMS2c4a7I4aOads38rsthwdaigBWagDWNH7bGsEZN7B0TszZuFAuU+XGjU5A66MIOfFfzbUg8AnByysr+XG5/bknFIrP/XhM2fbRr6gbYrFUK7TNkpgjFs5u3BzUrz2iTAV8uOpSJqKSnaf0pTZk1EywOK/X8W8ViIjc7Di3FzQcqIW9K3D27N+3rVsv8SRT1hWASVlnG6aThqqebiM8FCGCzAYVgQb3h3Wu8JT5fIz7Qo7A6siVRwNBwWwzP8HkGoinEK32Wsj/fDXk27vjpFQO/+9sV0xfcTbIZA6MnuYWF4rHOT59KcshCWCD3V0FopX57p/dtOzM9+6lxIctAT++izxWoZit/5c5A4633iY1d+RMeTko1POix6MSlxPMRHZUFwSXROgFuWWRpyD6TlUTCST9/wTTd0WDPklAAiYcnuEPW3qCnw0r0xkrA4AwWUXqXdAIwDt5bA27KcjRyY4Fofv9NxH09BNuBTXNPrvnYPZMmaKrv+HOX3NFTreuV6+5LJdhYUxYSBvSWo1jeWIQ5Q9RUdTU0PqmKpMhJKbKey/S4gxCXHg2HR8DwLCcbIZcvneF9yPEAT71YA6zpLKoPVSwWwH97huKSzjpic/RUfFXQOcgCQ=
+   bucket: docs.mattermost.org
+   local_dir: documentation-html
+   acl: public_read
+   region: us-east-1
+   skip_cleanup: true
+   detect_encoding: true
+   on:
+     repo: mattermost/platform
+     branch: master
+     go: 1.4.2
+     condition: $TRAVIS_DB = mysql

Makefile

@@ -106,7 +106,12 @@ travis:
 	@sed -i'.bak' 's|bundle.js|bundle-$(BUILD_NUMBER).min.js|g' $(DIST_PATH)/web/templates/head.html
 	rm $(DIST_PATH)/web/templates/*.bak
 
+	mv doc/README.md doc/index.md
+	mkdocs build
+	cp -r documentation-html $(DIST_PATH)/documentation-html
+
 	tar -C dist -czf $(DIST_PATH).tar.gz mattermost
+	rm -r $(DIST_PATH)
 
 build:
 	@$(GO) build $(GOFLAGS) ./...

doc/README.md

@@ -1,31 +1,26 @@
 # Mattermost Documentation 
 
-## General Information 
+## Installation 
 
-- [Mattermost Release Numbering Scheme](install/release-numbering.md)
+- [AWS Elastic Beanstalk Setup](install/Amazon-Elastic-Beanstalk.md)
+- [Docker Single Container Preview Setup](install/Docker-Single-Container.md)
+- [Production Ubuntu Setup](install/Production-Ubuntu.md)
+- [Mattermost Release Numbering Scheme](install/Release-Numbering.md)
+- [Software and Hardware Requirements](install/Requirements.md)
+- [SMTP Email Setup](install/SMTP-Email-Setup.md)
 
-## Administrator Documentation 
+## Integrations
 
-### Installation 
-
-- [Software and Hardware Requirements](install/requirements.md)
-- [Production Installation](install/prod-ubuntu.md)
-- [Local Machine Setup ](install/single-container-install.md)
-- [AWS Elastic Beanstalk Setup](install/aws-ebs-setup.md)
-- [Developer Machine Setup](install/dev-setup.md)
-
-### Configuration 
-
-- [GitLab SSO Configuration](integrations/sso/gitlab-sso.md) 
-- [SMTP Email Setup](config/smtp-email-setup.md)
+- [GitLab SSO Configuration](integrations/Single-Sign-On/Gitlab.md) 
+- [Incoming Webhooks](integrations/webhooks/Incoming.md) 
 
 ## Developer Documentation 
 
-- [Code Contribution Guidelines](developer/code-contribution.md)
-- [Developer Machine Setup](install/dev-setup.md)
-- [Mattermost Style Guide](developer/style-guide.md)
+- [Code Contribution Guidelines](developer/Code-Contribution-Guidelines.md)
+- [Developer Machine Setup](developer/Setup.md)
+- [Mattermost Style Guide](developer/Style-Guide.md)
 
-## End User Help
+## Usage Help
 
-- [Mattermost Markdown Formatting](help/enduser/markdown.md)
-- [Slack Import](https://github.com/mattermost/platform/blob/master/doc/import/slack-import.md)
+- [Slack Import](usage/Slack-Import.md)
+- [Mattermost Markdown Formatting](usage/Markdown.md)

doc/developer/Code-Contribution-Guidelines.md

@@ -23,7 +23,7 @@ git checkout -b <branch name>
 
 ## Programming and Testing 
 
-1. Please review the [Mattermost Style Guide](style-guide.md) prior to making changes.
+1. Please review the [Mattermost Style Guide](Style-Guide.md) prior to making changes.
 
    To keep code clean and well structured, Mattermost uses ESLint to check that pull requests adhere to style guidelines for React. Code will need to follow Mattermost's React style guidelines in order to pass the automated build tests when a pull request is submitted.
    

doc/install/Amazon-Elastic-Beanstalk.md

@@ -1,14 +1,14 @@
 
 ## AWS Elastic Beanstalk Setup (Docker)
 
-1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip) file provided. 
+1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip) file provided. 
 	1. From the AWS console select Elastic Beanstalk.
 	2. Select "Create New Application" from the top right.
 	3. Name the application and press next.
 	4. Select "Create a web server" environment.
 	5. If asked, select create an IAM role and instance profile and press next.
 	6. For predefined configuration select under Generic: Docker. For environment type select single instance.
-	7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip). Everything else may be left at default.
+	7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip). Everything else may be left at default.
 	8. Select an environment name, this is how you will refer to your environment. Make sure the URL is available then press next.
 	9. The options on the additional resources page may be left at default unless you wish to change them. Press Next.
 	10. On the configuration details place. Select an instance type of t2.small or larger.
@@ -24,4 +24,4 @@
 	### (Recommended) Enable Email 
 	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](SMTP-Email-Setup.md).

doc/install/Docker-Single-Container.md

@@ -75,7 +75,7 @@ The following install instructions are for single-container installs of Mattermo
 
 ## Configuration Settings
 
-There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in [config/config.json](config/config.json) or [docker/0.6/config_docker.json](docker/0.6/config_docker.json) if you're running a Docker instance.
+There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in `config.json` or `config_docker.json` if you're running a Docker instance.
 
 * *EmailSettings*:*ByPassEmail* - If this is set to true, then users on the system will not need to verify their email addresses when signing up. In addition, no emails will ever be sent.  
 * *ServiceSettings*:*UseLocalStorage* - If this is set to true, then your Mattermost server will store uploaded files in the storage directory specified by *StorageDirectory*. *StorageDirectory* must be set if *UseLocalStorage* is set to true.  
@@ -86,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](SMTP-Email-Setup.md).
 
 ## Upgrading Mattermost 
 

doc/integrations/webhooks/Incoming.md

@@ -25,7 +25,7 @@ In addition, if `Content-Type` is specified as `application/json` in the headers
 {"text": "Hello, this is some text."}
 ```
 
-It is also possible to post richly formatted messages using [Markdown](../../help/enduser/markdown.md).
+It is also possible to post richly formatted messages using [Markdown](../../usage/Markdown.md).
 ```
 payload={"text": "# A Header\nThe _text_ below **the** header."}
 ```

mkdocs.yml

@@ -0,0 +1,11 @@
+site_name: Mattermost Documentation
+site_url: http://docs.mattermost.org
+repo_url: https://github.com/mattermost/platform
+repo_name: GitHub
+site_favicon: favicon.ico
+copyright: "Copyright (c) 2015 Spinpunch, Inc. All Rights Reserved."
+strict: true
+docs_dir: doc
+site_dir: documentation-html
+use_directory_urls: false
+theme: mkdocs