Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
ramijarrar committed Jun 9, 2017
1 parent fa091fd commit f2d5e17
Show file tree
Hide file tree
Showing 11 changed files with 191 additions and 0 deletions.
1 change: 1 addition & 0 deletions documentation/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_build
20 changes: 20 additions & 0 deletions documentation/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = python -msphinx
SPHINXPROJ = MeteorAzure
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
35 changes: 35 additions & 0 deletions documentation/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# -*- coding: utf-8 -*-

import os.path
import sphinx_rtd_theme

# -------------------------------
# General
# -------------------------------

extensions = []
source_suffix = '.rst'
master_doc = os.path.join('pages', 'overview')
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# -------------------------------
# Project
# -------------------------------

project = u'Meteor Azure'
copyright = u'2017, Talos Technology Pty Ltd'
version = u'2.0.0-rc.4'
release = u'2.0.0-rc.4'

# -------------------------------
# Internationalization
# -------------------------------

language = 'en'

# -------------------------------
# Output
# -------------------------------

html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
36 changes: 36 additions & 0 deletions documentation/make.bat
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
@ECHO OFF

pushd %~dp0

REM Command file for Sphinx documentation

if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=python -msphinx
)
set SOURCEDIR=.
set BUILDDIR=_build
set SPHINXPROJ=MeteorAzure

if "%1" == "" goto help

%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The Sphinx module was not found. Make sure you have Sphinx installed,
echo.then set the SPHINXBUILD environment variable to point to the full
echo.path of the 'sphinx-build' executable. Alternatively you may add the
echo.Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://sphinx-doc.org/
exit /b 1
)

%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end

:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

:end
popd
2 changes: 2 additions & 0 deletions documentation/pages/command-line-interface.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Command line interface
======================
27 changes: 27 additions & 0 deletions documentation/pages/configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
=============
Configuration
=============

Azure portal
============

Settings file
=============

Tenant Id
---------

Deployment credentials
----------------------

Non-interactive login
---------------------

Custom web config
=================

Force HTTPS
-----------

Multi-core
----------
2 changes: 2 additions & 0 deletions documentation/pages/further-reading.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Further reading
===============
2 changes: 2 additions & 0 deletions documentation/pages/getting-started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Getting started
===============
14 changes: 14 additions & 0 deletions documentation/pages/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
============
Installation
============

Meteor Azure is available as an NPM package

Pre-requisites
==============

Dev dependency
==============

Global
======
3 changes: 3 additions & 0 deletions documentation/pages/migrating-from-1x.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
==================
Migrating from 1.x
==================
49 changes: 49 additions & 0 deletions documentation/pages/overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
========
Overview
========

Meteor Azure is a command line tool for deploying `Meteor`_ applications on `Azure App Service`_.

The project emphasises simple configuration out of the box, while providing heavy customisation for advanced usage.

Read the :doc:`tutorial <getting-started>` to get started, and report any issues or questions on our `GitHub repo`_.

.. _Meteor: https://meteor.com
.. _Azure App Service: https://azure.microsoft.com/en-us/services/app-service/
.. _Github repo: https://github.com/fractal-code/meteor-azure

CLI Features
============

- One command deploy
- Cross platform (macOS, Linux and Windows)
- Load Meteor settings from file
- Detect correct Node/NPM versions
- Track deploy progress in real-time
- Support custom web config

Azure platform benefits
=======================

- Auto-scaling
- Zero-downtime deployment
- High availability (with `99.95% SLA`_)
- `34 regions`_ around the world
- Dedicated VMs
- Multi-core session affinity
- Configure advanced architectures (e.g multi-region failover)
- Security compliance (ISO, SOC and PCI)

.. _99.95% SLA: https://azure.microsoft.com/en-us/support/legal/sla/app-service/v1_4
.. _34 regions: https://azure.microsoft.com/en-us/regions

.. toctree::
:hidden:

self
installation
getting-started
configuration
command-line-interface
migrating-from-1x
further-reading

0 comments on commit f2d5e17

Please sign in to comment.